search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Class diagram for `Model` component is too complicated #3556

Open nus-pe-bot opened 2 days ago

nus-pe-bot commented 2 days ago

Description

I feel that this class diagram contains too much information, which makes it challenging for the reader to understand.

While the class diagram does look valid, I feel that there would be merit in breaking up the current diagram into two or three smaller diagrams.

For example, I think extracting the Policy elements in the current Model class diagram (seen below) into a separate class diagram would make the DG more readable.

Screenshot of Class Diagram

uml-complicated.png

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

ckaayy commented 1 day ago

Team's Response

Thank you for your suggestion! However as the intent of this diagram is to let developers familiarize with the different fields in Prudy classes, we wanted to display the information in one diagram to allow for better readability. We have carefully considered the different options when displaying the information, and ultimately decided that splitting up the diagram may cause more confusion to the reader as they cannot view the information all in one place. Furthermore, while it is one of the bigger diagrams in our developer guide, we felt that it is relatively easy to follow as much of the nitty-gritty details have already been omitted. We would also like to politely highlight that this bug can be considered more of a suggestion, which should not have been brought up, as shown in the screenshot below taken from CS2103 website.

Lastly, if it is eventually decided that this diagram is in fact considered a bug, we would like to suggest it to be a VeryLow severity bug since it seems to be a cosmetic issue.

image.png

Duplicate status (if any):

--