search

nus-cs2113-AY1920S2 / pe-dev-response

0 stars 0 forks source link

UG: Maybe it's better to further explain is `<>` unnecessary in an actual input #688

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 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.

It's better to further explain that <> isn't needed in an actual input.

Becasue as an user, I may simply look at the command format and skip the examples of usage part.

[original: nus-cs2113-AY1920S2/pe-interim#691]

matthewc97 commented 4 years ago

Team's Response

The purpose of the angle brackets is to distinguish between the parameter names and the actual input itself.

image.png

We felt that it would be natural for most users to refer to the examples of usage sections if they were unsure of the input required from them. If users refer to the examples of usage section, it would be clear the the angle brackets are not part of the input required from them.

However, if this is still confusing for most, we can possibly change the format of the parameter names from e.g. <Contact Name> to CONTACT_NAME and add a short section to explain the command format.

Duplicate status (if any):

--