search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

[UG] Command Summary with wrong command syntax #782

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

image.png

The use of slashes here \/ is confusing, it is used to mark short and long form commands, as well to mark the labels that is allowed in the command. In the worst case the user may never be able to run a command at all.

[original: nus-cs2103-AY2425S1/pe-interim#1102] [original labels: severity.Medium type.DocumentationBug]

ghos7ie commented 1 week ago

Team's Response

Rejected, severity medium doesn't really make sense here either.

It is meant to be a summary for commands after users read through the UG.

Additionally, we split the command words as well in the features section and did not use the short form command in the format part. image.png

Duplicate status (if any):

--