search

nus-cs2113-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Diagram being cut off affects readability #1290

Open nus-pe-bot opened 2 years ago

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

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

Teanweijun commented 2 years ago

Team's Response

Although the diagram has been cut off, and the words have been very minorly affected, it does not affect readability. In addition, the understanding of the diagram will not be affected as well as the returning arrow that immediately follows has the full unaffected text. Based on all the usage of the optional path in the sequence diagram, it can also be intuitively understood that the object being returned is the exception, and thus leads to no misunderstandings. Therefore, the diagram being cutoff is merely a cosmetic issue from its spacial positioning and does not impede the reader's usage or understanding of the diagram.

Duplicate status (if any):

--