search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

No Example Commands Given for many Commands in the UG #4261

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.

Examples of commands are given for most of the commands in the UG.

Screenshot 2023-04-14 152851.png

However, as far as I can find, checkout, and overview doesn't have examples. This affects new users who want to quickly try the commands and also results in inconsistency.

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

Tohtoroo commented 1 year ago

Team's Response

image.png

The example commands were given under command summary, which came before the individual commands' explanation. For simple commands like these which only required a single input, There does not seem to be a point in repeating, especially since the application's target audience is for adults working in NEA.

Duplicate status (if any):

--