search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Student class diagram should show `ModuleCode` class separately #4324

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.

Since the class ModuleCode is a custom class and is never mentioned before in the DG, the diagram should show this class separately and have the Student class assoicated with ModuleCode with * as the multiplicity.

image.png

[original: nus-cs2103-AY2223S1/pe-interim#4384] [original labels: severity.VeryLow type.DocumentationBug]

leongdl135 commented 1 year ago

Team's Response

The ModuleCode class is mentioned several times in our developer guide, as shown below.

image.png

We believe that a clear way to show the difference between ModuleCode for studentModuleInfo and teachingAssistantInfo is to show it under the class attributes. If were we to go by your suggestion, it might be hard to differentiate which ModuleCode belongs to studentModuleInfo or teachingAssistantInfo. Additionally, this is to reflect that the ModuleCodes are stored in a Set.

Lastly, I believe that there are many ways to draw a UML diagram to demonstrate what is happening. This is just one of the ways we chose and should not be a bug. Thanks for your suggestion.

Duplicate status (if any):

--