nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

No diagrams for common classes #1197

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.


image.png

The developer includes diagrams for Logic, Storage, Ui, etc so by right the reader will expect a diagram for common classes as well.


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

JasonYapzx commented 1 year ago

Team's Response

Quoting from the text book, the DG is meant to help future developers, for developers, should be able to understand the code without detailed diagrams for common classes, hence we decided to omit these diagrams for the common classes.

image.png

Duplicate status (if any):

--