Magmanat / pe

0 stars 0 forks source link

Inconsistent use of Loop in Sequential Diagram for Diagnosis algorithm #11

Open Magmanat opened 1 year ago

Magmanat commented 1 year ago

image.png

As shown in the circled components, a loop box should have been used for both of these boxes but only one of them was used, and one of them was mislabelled for each child of illness

nus-se-bot commented 1 year ago

Team's Response

We believe that the diagrams should be clear for users to read. We were not taught how to represent a "for each" loop in the UML sequence diagram, and thus what you see in the second loop is not a number but a verbal statement to try to clarify what actually happens. In the first loop, since all the children of Illness are not stored in an array, we instead tried to represent them clearly using a verbal loop. We would be interested if there truly is a way to represent them properly, but at the moment, the diagram has no clarity problems.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: You claimed that we were not taught how to represent a "for each" loop,

the following image is taken from the cs2113 website

image.png

As shown a "for each" loop is meant to be like this, hence I disagree


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This causes a large ambiguity with the diagram, and since you are following non-standard notations, it will result in developers to be confused when looking at this diagram, and it is not only a typo/spacing/layout/color/font issue.