search

ng-andre / pe

0 stars 0 forks source link

Commands class diagrams are too complicated #12

Open ng-andre opened 2 years ago

ng-andre commented 2 years ago

image.png

Commands class diagrams are too complicated and can be abstracted into the various classes respectively. The overview should be simple and easy to understand at a glance, and the specifics should be under the relevant classes that are being explained in detail. The complicated diagram also results in small text inside the class diagram, hurting user readability.

soc-se-bot commented 2 years ago

Team's Response

There has been some level of abstraction of the commands component into multiple class diagrams.

The 'Original' Bug

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

Commands component diagram too complicated

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

the diagram here is too complex and is too large for the user to read and understand, perhaps can break it up into smaller segments

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

Their Response to the 'Original' Bug

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

Commands component has already been broken up into multiple class diagrams. What you have shown here are actually 2 separate diagrams on top of each other. While I can see why it may still seem quite complex, the purpose is to display the details of all the various command classes at one glance for the user (rather than writing it in the description, which would lead to a very long and wordy explanation as we have many command classes). I would say the severity should be VeryLow as it is more cosmetic in nature.

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]