search

Charles1026 / pe

0 stars 0 forks source link

Import Command Sequence Diagram too complicated and text too small. #19

Open Charles1026 opened 1 year ago

Charles1026 commented 1 year ago

The diagram is too complicated, it should have been split into smaller diagrams with reference frames. The text is also too small to be readable

image.png

nus-se-script commented 1 year ago

Team's Response

Duplicate of #1773, as it also points out that the diagram is too complicated.

The 'Original' Bug

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

overly complicated sequence diagram

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.

maybe can break it up into the 2 like json has one diagram and csv has one diagram on its own

image.png

[original: nus-cs2103-AY2223S1/pe-interim#2291] [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: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: Very low is only reserved for issues that do not affect readability. Tiny text in the diagram and its complexity greatly affects readability and should be marked as low, as mentioned in the notes.