search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Several Diagrams not given in standardized pUML format #4016

Open nus-se-script opened 9 months ago

nus-se-script commented 9 months 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.

The format of several diagrams in the DG was not given in the conventional format taught in the CS2103/T textbook.

image.png

image.png

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

eyelessrhyme7 commented 9 months ago

Team's Response

Both the diagrams are correct. Diagrams in our DG are completely accurate as per our implementation. It is repeatedly mentioned in the lectures and the tutorials that minor deviations are okay, as long as the intended message is clear. It is a partial class diagram in the DG, therefore, doesn't need to include everything.

Duplicate status (if any):

--