search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UML diagram forgotten methods for NoteCommand #5493

Open nus-pe-bot opened 2 months ago

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

Screenshot 2024-04-19 at 5.20.25 PM.png

I believe you forgot a couple of methods such as the generateSuccessMessage method.

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

lihaoquan commented 2 months ago

Team's Response

Thank you for raising this. This was indeed an oversight, but as per the course textbook:

image.png

The generateSuccessMessaage and generateDate methods are simply extracted out to improve code readability and quality. I believe that the current diagram still serves the purpose of providing a high level view of NoteCommand itself, as this is mainly to show the attributes associated to the command that differs from other commands. However, if given a chance to fix, I would definitely add the missing methods in to provide additional information.

Duplicate status (if any):

--