search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Commons is mentioned under design - architecture without being in the diagram #3126

Open nus-pe-bot opened 3 years ago

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

Users may get confused after looking at the diagram and does not understand where the Commons comes from, and the hyperlink it redirects to does not have a detailed explanation either of how commons is used

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

enhao25 commented 3 years ago

Team's Response

Hi, we have explained about the common classes in the DG under the Common classes section. We didn't include any diagrams / more explanation for this class as we felt that it is not "critical" for the user and even with the omission, the user should still understand the diagrams. The only purpose of the common class is just to be used by any class when it is needed to ensure that we do not have duplicated codes.

image.png

Please refer to the forum here: https://github.com/nus-cs2103-AY2021S2/forum/issues/322

Duplicate status (if any):

--