search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Messy UML diagram for `Ui.java` #28

Open nus-se-script opened 5 months ago

nus-se-script commented 5 months ago

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

PersonCard should be directly below PersonListPanel and not MeetingCard. The current diagram is confusing

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

KohGuanZeh commented 5 months ago

Team's Response

Thank you for the bug report.

However, according to the PE specifications, the possible bugs for UML diagrams are as follows:

image.png

We felt that the diagram is not overly complicated and even when PersonCard is not directly below PersonListPanel, the arrow still shows a correct respective association that is still direct and clear to see. As we are also using PlantUML, adding PersonCard under PersonListPanel causes the diagram to make it harder to see the association to Model which is arguably worse.

image.png

Hence, as the report does not seem to violate any of the PE specified bug reports, we feel that the bug report should be invalid.

Duplicate status (if any):

--