search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Messy formatting in Command Summary #2573

Open nus-pe-bot opened 3 years ago

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

Perhaps the column for examples could be wider (and make the "Format" column narrower). There could also be line breaks between the different examples for clarity and easier reading.

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

onnwards commented 3 years ago

Team's Response

This is just a suggestion on the styling of the documentation. The example commands are on different lines, and should be quite self explanatory to the user.

Duplicate status (if any):

--