sugiyem / pe

0 stars 0 forks source link

Unreadable sequence diagrams #10

Open sugiyem opened 2 years ago

sugiyem commented 2 years ago

The sequence diagram of editstu and medit in the DG is unreadable as it is too small.

image.png

image.png

soc-se-bot commented 2 years ago

Team's Response

Hi, thanks for your feedback, we feel that this is a limitation of using plantUML to make our UML diagrams as this is the size that we obtained upon exporting the plantUML file to png format. Also, we could not omit more details in the sequence diagram as it is crucial for developers who want to understand how our commands work for medit and editstu. Furthermore, they are at the same level of abstraction.

Hence, we feel that the severity should be reduced to VeryLow instead as this is more of a cosmetic issue due to a limitation of plantUML.

The 'Original' Bug

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

editstu and medit model sequence diagram is 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.


Compared to the font size of the surrounding contents, the diagram size is too large that the text inside is almost unreadable.

image.png

image.png


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

Their Response to the 'Original' Bug

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

Duplicate of issue 4335

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]

Reason for disagreement: [replace this with your explanation]