nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing diagrams other than sequence diagram in DG #1339

Open nus-pe-bot opened 2 months ago

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


In DG, sequence diagrams are provided for basically every feature. However, only one class diagram is provided for Parser. As each of the features contains the interactions among many classes, more class diagrams to illustrate the features may be clearer and easier to understand.


[original: nus-cs2113-AY2324S2/pe-interim#1197] [original labels: severity.Medium type.DocumentationBug]

nickczh commented 2 months ago

Team's Response

Thank you for your observation.

We admit that we focused way more on doing Sequence diagrams that we managed to only provide one class diagram. This issue is a duplicate of #911 as they both raised the same issue of having missing diagrams.

Duplicate status (if any):

Duplicate of #911