nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Missing notes field in UML #4008

Open nus-se-script opened 7 months ago

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


According to Meeting.java file, Meeting class should have list of Note.

image.png

image.png


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

jacobcuison commented 7 months ago

Team's Response

Great catch! We acknowledge that there is indeed a missing Note association for Meeting.

However, severity has been downgraded to Low as the core purpose of this diagram is to explain the relationship between Contact, Meeting, UniqueContactList, UniqueMeetingList, and UserPrefs, rather than the attributes that constitute the Contact or Meeting class.

Here is the accompanying text for reference:

image.png

Hence, in the context of what the the diagram is trying to explain, we think that the diagram still does a good job in illustrating the relationships between the aforementioned classes. Thus, the lack of the Note association will not affect a reader's understanding of these core relationships.

Duplicate status (if any):

--