search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

Poor formatting of DG, leaves a large chunk of white space before instructions about displaying a diagram #4017

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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-04-14 153152.png

Here, ending the page with a semi-colon followed by a large chunk of white space might confuse readers into thinking there is missing content. This is also not visually unappealing and lacks some degree of professionalism.

[original: nus-cs2103-AY2223S2/pe-interim#3628] [original labels: severity.VeryLow type.DocumentationBug]

gitsac commented 1 year ago

Team's Response

The PDF conversion makes the DG formatting look worse. Additionally, the sequence diagram size should not be shrunk as this will cause the diagram to be unreadable. The entirety of the sequence diagram provides a clearer context rather than splitting the sequence diagram into 2 by using reference frames to abstract out certain portions. Therefore, we do not believe that this is an actual documentation bug.

Duplicate status (if any):

--