nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Non-standard UML notation for multiplicity #2200

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.


image.png

Page 11 of the DG.

Expected: Multiplicity should be shown using only a single * symbol. all and filtered are additional notes that should not be shown in the multiplicity field. Use UML notes instead.


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

yleeyilin commented 2 months ago

Team's Response

This is not explicitly mentioned that you are not allowed to have words next to the multiplicity. Furthermore, this would not lead to confusion in what it represents since this notation is not being re-used anywhere else for other purposes. Below is a screenshot showing how our notation is valid since it does not contradict other notations.

telegram-cloud-photo-size-5-6138804929951809285-y.jpg/var/folders/tg/yrcwyrrj2_qc1tf0swypgctw0000gn/T/ru.keepcoder.Telegram/telegram-cloud-photo-size-5-6138804929951809285-y.jpg

Furthermore, in Week 4 Quiz, our UML diagram is highly similar to the one shown in the quiz, which has the note next to the multiplicity.

telegram-cloud-photo-size-5-6138804929951809398-y.jpg/var/folders/tg/yrcwyrrj2_qc1tf0swypgctw0000gn/T/ru.keepcoder.Telegram/telegram-cloud-photo-size-5-6138804929951809398-y.jpg

In our case, the note enhances our diagram as it makes our diagram clearer in terms of explaining how the uniquePersonLists have all the persons while the modelManager contains the filtered contacts list.

telegram-cloud-photo-size-5-6138804929951809364-y.jpg /var/folders/tg/yrcwyrrj2_qc1tf0swypgctw0000gn/T/ru.keepcoder.Telegram/telegram-cloud-photo-size-5-6138804929951809364-y.jpg

Duplicate status (if any):

--