nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Too congested UML diagram for CourseMateListPanel #4219

Open nus-pe-bot opened 5 months ago

nus-pe-bot 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.

Screenshot 2024-04-19 at 5.31.00 PM.png

The diagram is too congested and is hard for the reader to follow

_{[original: nus-cs2103-AY2324S2/pe-interim#5326] [original labels: severity.Medium type.DocumentationBug]}

benson1029 commented 5 months ago

Team's Response

Thank you for your report. The UML diagram only has 6 classes and the more "congested" part (the association multiplicities) have 4 identical multiplicities * and 4 identical multiplicities 0..1. The team believed that it should be very easy to follow.

However, we agree that the overlapping between the association lines and the multiplicities is not ideal. Therefore, we will be accepting this as a very low severity documentation bug, as this is a cosmetic issue.

Duplicate status (if any):

--