nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

Wrong UML sequence diagram #2395

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.


Looking at your code, ListCommandParser actually calls on ParserUtil before it calls on the predicate class.

Your UML diagram is wrong and does not reflect your actual code.

Screenshot 2023-04-14 at 3.26.20 PM.png


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

chia-yh commented 1 year ago

Team's Response

This DocumentationBug is reclassified at a Low severity, and is rejected. The UML diagram shown reflects the relevant details necessary to understand the list operation. The ParserUtil mentioned in the report is something that was considered to not be important in understanding how the operation is handled, and the behavior of the Parser classes is also covered in another section of the DG (shown below), and was thus intentionally removed from the UML diagram in the interests of avoiding unnecessary repetition.

image.png

Duplicate status (if any):

--