search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Lack of class and object diagrams for DG from page 26 onwards #817

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.

Only Sequence Diagrams are observed in the DG from this page onwards. I recommend addition of class and object diagrams to provide more clarity to the developers, instead of relying mainly on the Sequence Diagrams.

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

xzynos commented 1 year ago

Team's Response

Greetings karthikstar,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) After consultations with the professor, a conscious design choice was made not to include class diagrams to describe how commands are handled as they would not bring any additional value to the sequence diagrams.

2) The reported issue does not affect the functionality of the developer guide and we are not accepting suggestions as bugs.

Regards, xzynos

Duplicate status (if any):

--