nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

UML Diagram notation issues #486

Open nus-pe-bot opened 3 years ago

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


Should the UML diagrams have be indexed as such? Also should the functions be e.g. getOption() instead of getOption instead? Also, should the class names start with a : as per the UML notation taught in class? Lastly, should the text in the diagram not be underlined? Screenshot 2021-04-16 at 5.21.35 PM.png


[original: nus-cs2113-AY2021S2/pe-interim#486] [original labels: severity.High type.DocumentationBug]

L-Irvin commented 3 years ago

Team's Response

We should have double-checked the diagram for our final documents.

Duplicate status (if any):

--