search

nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

UI class diagram errors #701

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.

UML is labelled abstract but is not abstract. In addition, the static methods in UI are not underlined in the class diagram. This could lead to serious misunderstanding for new developers. image.png

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

Samueltansw commented 1 year ago

Team's Response

Thanks for pointing that out. I did not double check the class diagram with the code. But I don't think the severity would be high, because the IDE will catch that we are instantiating an abstract class and point us the error. Which can be easily changed.

Duplicate status (if any):

--