tanruiquan / pe

0 stars 0 forks source link

DG: Hard to read sequence diagram #16

Open tanruiquan opened 2 years ago

tanruiquan commented 2 years ago

Expected: the sequence diagram to only show details for one component at a time. Similar elsewhere too.

Actual: Sequence diagram is very hard to understand Screenshot 2021-11-12 at 5.19.41 PM.png

nus-pe-bot commented 2 years ago

Team's Response

Thank you for your effort and time. The severity of the issue with "too detailed diagram and too small text" should be VeryLow.

1636786704(1).png

The 'Original' Bug

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

DG sequence diagram have so many low-level details

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.


image.png

  1. I mean, firstly this is literally impossible to read.

image.png

  1. This part could be abstracted out as it is not necessary to know the low-level details here. (perhaps just 1 parseDetails would do?)

image.png

  1. Here as well, there isn't a need to write out so many similar function calls.

[original: nus-cs2103-AY2122S1/pe-interim#5113] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for your effort and time. The severity of the issue with "too detailed diagram and too small text" should be VeryLow.

1636786704(1).png

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]