search

ConradLew / pe

0 stars 0 forks source link

Cluttered sequence diagram for view class command #10

Open ConradLew opened 1 year ago

ConradLew commented 1 year ago

image.png

Too many classes are involved in the sequence diagram which makes the diagram very cluttered and hard to understand.

nus-se-script commented 1 year ago

Team's Response

Even though we believe that the classes indicated in the diagram is necessary for the explanation of the ViewClassCommand execution however, we do recognise that indeed the Sequence Diagram may perhaps be too small and could have been illustrated better for easier viewing by the reader (eg. bigger image size or larger font).

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

ViewClass sequence diagram is too small to be viewed comfortably

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

The sequence diagram used to illustrate how view class command works has too small a font size, requiring squinting or excessive zooming to see the details.

image.png

[original: nus-cs2103-AY2223S1/pe-interim#3061] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: My issue argues that there are too many classes in the diagram to understand, rather than the fact that it is too small. The two issues are not the same.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: The team has not provided any reason for the downgrade in severity. Having too many classes in the diagram that cause clutter is not a cosmetic issue as it can actually affect the understanding of the reader; the current diagram does not work just as well for allowing users to understand the design and cannot be changed by correcting a typo or minor formatting error.