nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Insufficient explanation of Common classes in DG #1306

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.


Under section 2.6 Common Classes, it would have been nice to know what are the roles and functionalities of these common classes. (exceptions, welcome messages? etc.)

Screenshot (282).png


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

RainyCodeWizard commented 3 years ago

Team's Response

We believed that the classes in commons are not really noteworthy from a design perspective, and does not require special attention for the developer to understand.

Also, we followed the standard of AB3 and AB4 when writing the DG. As shown in AB4:

image.png

Duplicate status (if any):

--