nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

DG: Incorrect UML diagram for Model Component #580

Open nus-se-script opened 11 months ago

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

ModelManager does not keep a direct reference to Person or Event objects. As such, the arrow should be a dashed arrow instead of a solid arrow to represent a dependency instead of an association.

For reference, the definition of an association from the textbook: An association is a relationship resulting from one object keeping a reference to another object (i.e., storing an object in an instance variable)

This UML diagram could cause readers to misunderstand the internal workings of the ModelManager class.


[original: nus-cs2103-AY2324S1/pe-interim#488] [original labels: type.DocumentationBug severity.Medium]

Nixx162 commented 11 months ago

Team's Response

Using the same definition given in the issue, we think we could safely classify our use as association and not dependency, since we are storing Person and Event instances in variables.

Duplicate status (if any):

--