search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Spaces between points and point identation in UG #2545

Open nus-se-bot opened 2 years ago

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

Consider using indented subpoints for usage examples, or adding whitespace between 'Main mode:' and 'Enter into:...'. For a reader, it was quite confusing at first glance.

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

IshaaanVyas commented 2 years ago

Team's Response

Thank you very much for this suggestion, it is accepted as this would make the User Guide easier to read for new users.

Severity is changed to VeryLow as this is mainly a cosmetic issue and does not affect the usage of the application.

image.png

Duplicate status (if any):

--