search

nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Inconsistent themes for class-diagram #2054

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years 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.

The following class-diagram found in the section "Adding a Person Feature" Screenshot 2022-04-16 at 3.26.52 PM.png has a different style than the one in other parts of the Developer Guide,

Screenshot 2022-04-16 at 3.28.57 PM.png

Screenshot 2022-04-16 at 3.27.05 PM.png

Comments

Not sure if there is a standard styling to follow as part of CS2103/CS2103T, but ideally should stick to a consistent style for all class diagrams; ie if all classes belonging to the Command component are coloured blue, and all classes belonging to the Model component are coloured red, this should be adhered to in all class-diagrams!

As this is quite cosmetic, I feel that the severity is "VeryLow"

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

Fenway17 commented 2 years ago

Team's Response

This is not a bug, as there are no errors here. Author of issue is also "Not sure". This is merely a suggestion.

Duplicate status (if any):

--