nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

revenue implementation lacks depiction #2160

Open nus-pe-bot opened 2 years ago

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


revenue lacks the depiction in terms of diagrams and with many classes involve, developers may not be able to understand the details of implementation. Hence, it would be better to include depict these details through UML diagrams.

Without diagram, implementation will not be properly understood by developers and they could be improper enhancement to the feature in future.


[original: nus-cs2103-AY2122S2/pe-interim#2156] [original labels: severity.Medium type.DocumentationBug]

jaegarpoon commented 2 years ago

Team's Response

Hi tester, thanks for pointing this out! Our team left out the UML diagrams for some of the commands as the diagrams are similar (in fact, almost identical) to the other commands listed, eg. Add/Delete/Edit driver, Add customer, etc.

The addition of multiple duplicated diagrams for every command with slight changes in method names is unnecessary in our opinion. Moreover, step-by-step descriptions were provided in the DG for every command, which is sufficient in our opinion to understand that the nature and process of each command is similar in nature.

Understood that there are multiple issues, one for each command posted with the same description. Will be listing the rest as duplicates of this as well :)

Duplicate status (if any):

--