NgYaoDong / pe

1 stars 0 forks source link

Bug for Sequence Diagram being too large #10

Open NgYaoDong opened 2 months ago

NgYaoDong commented 2 months ago

Documentation Bug (Severity LOW)

This Sequence Diagram of ProcessCommand is a little too large, and when zooming in, the finer words become blurry.

image.png

nus-se-bot commented 2 months ago

Team's Response

Agree. But it purely due to cosmetic

The 'Original' Bug

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

[DG] Sequence Diagram too large

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.


It is difficult to read all the various commands, as well as the different functions that are being carried out in this one Sequence diagram. Perhaps using refs to break down this sequence diagram would be more useful to developers.

image.png

Some sequence diagrams are also overly long, being nearly one page long. Perhaps it would be better to split them into separate diagrams for better readability.

image.png


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

Their Response to the 'Original' Bug

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

agree but it is purely cosmetics

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: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]