search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Wrong example format in UG #1219

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

In UG, a given command example is add Shopee which does not produce valid result in the actual app.

image.png

[original: nus-cs2103-AY2122S1/pe-interim#1181] [original labels: severity.VeryLow type.DocumentationBug]

tianyue58 commented 2 years ago

Team's Response

The line "if the User Guide states add COMPANY_NAME", users can input add Shopee" is there to illustrate the point that words in UPPER_CASE are parameters to be supplied by the user. This conditional statement in UG merely serves as an example to explain a point to the users and it is not meant to show the user an actual command in our app.

Duplicate status (if any):

--