search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

class diagram difficult to read #1159

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 the DG, there is only 1 class diagram for all the classes, too many lines and classes makes the diagram difficult to read as seen below:

image.png

can consider splitting into smaller diagrams based on features

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

dylansiew commented 2 months ago

Team's Response

Thank you for noticing this, we assumed it could be zoomed in but we agree that it could be split into smaller diagrams for clarity

Duplicate status (if any):

--