search

nus-cs2113-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Vastly differing text sizes in images (UG, page 16, 17...) #686

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.

The UG is overreliant on diagrams, resulting in vastly differing text sizes as follows. A screenshot of accompanying text is included for reference. Instead, the team can adopt code blocks.

Page 16:

image.png

Page 17:

image.png

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

BradenTeo commented 2 years ago

Team's Response

Apart from the suggestion of using code blocks (which may be unsuitable for displaying our timetables), having differently sized text does not impact the readability of the UG. It seems more like a "preference" than a "flaw".

Duplicate status (if any):

--