search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Better formatting of UG command summary table #527

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.

pe1.png

The current command summary is confusing to read, especially for the longer commands like view and add. Consider using a table instead, broken down into different sections such as command, parameters, optional parameters etc.

[original: nus-cs2113-AY2223S1/pe-interim#551] [original labels: severity.Low type.DocumentationBug]

gaoyunfan commented 1 year ago

Team's Response

Cosmetic issues.

Duplicate status (if any):

--