search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Complicated sequence diagram #1702

Open nus-se-script opened 2 months ago

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

image.png This diagram might have been too complicated and defeats its purpose of allowing developers to understand the general idea of what the list sales by day function command is doing. This sequence diagram is one entire page big/long.

A large diagram such as this might hinder the readability of the user. As stated in the textbook, you can use ref to break sequence diagrams into multiple diagrams. image.png

image.png

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

MonkeScripts commented 2 months ago

Team's Response

Indeed, some of the sequence diagrams are too long and can be truncated.

Duplicate status (if any):

--