search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

The word option makes it seem optional/to be selected or unselected #1361

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.

When discussing the command format, the word option is used to describe the parameters. This led me confused as option would usually refer to something I either need to select or not (optional). However the parameters are compulsory.

image.png

[original: nus-cs2113-AY2021S2/pe-interim#1361] [original labels: severity.Medium type.DocumentationBug]

jonahtwl commented 3 years ago

Team's Response

The team agreed to use the words option as, for example -e -i -s are options to be chosen.

Duplicate status (if any):

--