search

nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Placement of methods in sequence diagrams #614

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

The methods should all be placed close to the arrowheads. in the picture, i can't tell/read clearly which of the arrows the method belong to. especially printMessage. This error is occuring in many of the other sequence diagrams and as a whole it affects the readability of the diagram since i have to retrace the diagram.

Initially a low severity. but it became medium because of the frequency of occurence

image.png

[original: nus-cs2113-AY2425S1/pe-interim#393] [original labels: severity.Low type.DocumentationBug]

lucas-sc0 commented 1 week ago

Team's Response

Thank you for raising this issue! But according to the textbook, there isn't any part that says "methods should all be placed close to the arrowheads" and PrintMessage is clearly referring to the arrow directly beneath it just like all the other arrows. Furthermore, it is pointing to UI. Hence our team feels that this is not in scope.

If it is however deemed to be in scope, it is purely cosmetic and still very much understandable an hence a very low severity.

Duplicate status (if any):

--