nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistency between UML diagram of Model class and UML diagram for OOP design for Person class below #1816

Open nus-se-script opened 2 months ago

nus-se-script commented 2 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.


In the main UML diagram of the model class, Person class does not contain Role as an attribute. However, the UML diagram below shows that addressbook contains UniqueRoleList as an attribute with Person class having reference to any number of Roles. As a developer, I feel that this might be a bit confusing since the developer would not be sure which UML diagram is correct (i.e. developer would not be sure whether addressbook contains uniquerolelist, and whether person contains role due to the discrepancy bewteen two diagrams). THe main model UML could add these extra classes.

Screenshot 2024-04-19 at 5.16.37 PM.png

Screenshot 2024-04-19 at 5.29.26 PM.png


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

chuahjiajie commented 2 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

Duplicate of #801