search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Lack of use of activity diagram instead of describing behavior #406

Open nus-se-script opened 12 months ago

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

Screenshot 2023-11-17 at 17.27.17.png

This section could be better served with an activity diagram showing the different flows of the program, rather than simply textually describing it

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

jx124 commented 11 months ago

Team's Response

Thank you for pointing this out, however, we believe that the explanation is rather clear and a diagram is not needed even though it is a good-to-have. This can be improved in a future iteration.

Duplicate status (if any):

--