search

nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

Parser class UML class diagram errors #424

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.

Parser class is labelled abstract but is not abstract. In addition, static methods are not underlined. image.png

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

Samueltansw commented 1 year ago

Team's Response

Hi thanks for pointing that out. But we disagree with the severity of this bug. If developers were to ever try to replicate our product based on our DG, and they use an abstract class for Paser, the IDE will give an error stating the instantiation of abstract class, which he / she can then change. It will only cause minor inconvenience. Not underlining static methods for this case does not affect the implementation, because static or non-static methods works equally well. The developer just has to instantiate the Parser class before using the methods.

Duplicate status (if any):

--