search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

DG: Undo sequence diagram shows internals of more than one main component #1353

Open nus-se-script opened 10 months ago

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

According to prof, who stated in one of the issues on the Github forum, you should not show the internals of more than one main component - you should split it into two.

Screenshot 2023-11-17 at 5.33.30 PM.png

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

kohkaijie commented 10 months ago

Team's Response

I accept this is a valid bug. However the severity of this issue should be Low instead of Medium as it does not cause inconvenience to the reader as they can still understand the diagram clearly and this issue is simply a design flaw where there is too much information included, and the diagram should be split up.

Duplicate status (if any):

--