nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Barely legible text for diagrams #3176

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.


Expected:

Actual:

More examples: image.png

image.png


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

kaixin-hc commented 2 years ago

Team's Response

1) This is purely cosmetic

2) WRT the sequence diagram, while in most cases we would agree, for these two the process is already explained in detail before the diagram. All the parts in the diagram are 'essential details' as it is intended to be a low-level illustration of the way the command works; splitting the diagram into 2 will obstruct the meaning even more. (As you can see, it is a single command)

Duplicate status (if any):

--