search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistency of display of help commands shown in UG #1056

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months 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.

UG Screenshots: image.png

image.png

image.png

Reflect help includes: "5. reflect help: Get help menu for reflect commands" Fitness help includes: "8. fitness help: Get help menu for reflect commands"

However, for the other help commands (e.g. sleep help), the help command was not listed as a command for the feature as shown in the screenshots when it should be a valid available command that can be executed as mentioned by the description (shown below). Perhaps the UG description should be more explicitly as to whether the help command will be purposely excluded from the printed list of commands available.

image.png

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

damiwee commented 6 months ago

Team's Response

Agreed, we should have standardized. However, we would argue that the this is purely cosmetic and does not affect usage, hence the severity should be very low.

image.png

Duplicate status (if any):

--