nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

DG does not show the link between `Links` and the other models #2654

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Description

There is absolutely no mention of how the Links between pets and owners are stored or their models are kept track of in the Model and Storage sections of the DG as they have presumably not been updated. Issue has been put at medium severity as readers would not know what the association between Link and Pet/Owner is without looking at the code.

Possible Solution

Update the UML diagrams for Storage and Model to include Links to show the association between these classes

Relevant Screenshots

image.png

image.png


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

jloh02 commented 1 week ago

Team's Response

Thank you for your report and this is an oversight.

Duplicate status (if any):

--