search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Class diagram of Command #560

Open nus-pe-bot opened 5 months ago

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

It can be seen that the Command classes inherit from the abstract class Command, and some classes inherit from the abstract classes ListActionCommand and TransactionActionCommand. I think it would be beneficial if there could be more in depth explanation on the details of the implementation, as it is unclear why there are two separate abstract command classes in addition to the main abstract Command class. There could be additional details on the abstract methods that subclasses would inherit.   image.png

[original: nus-cs2113-AY2324S2/pe-interim#489] [original labels: severity.Low type.DocumentationBug]

NgYaoDong commented 5 months ago

Team's Response

Hi there, thank you for the report.

Indeed you are right that we can add in abstract methods for the abstract classes. However, our DG has been revised with the teaching team that it was okay to omit these abstract classes in order to keep the diagrams simple. In addition, as can be seen from the image of AB3 class diagram below, they have also omitted all kinds of methods or variables from their classes, therefore we found it unecessary to include the methods and variables in the class diagrams.

image.png

Thank you again for the report!

Best Regards, StockPal Team

Duplicate status (if any):

--