nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency in UG examples #3003

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

In the examples section in the UG, the format in which an example is elaborated with is not consistent. Taking the add command as an example, a new user might not know what this example is talking about as there is no further elaboration in the examples section. However for other commands like find, there is further elaboration what the command does in the examples section.

Add command:

image.png

Find command:

image.png


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

KennyLewi commented 1 week ago

Team's Response

The examples are self-explanatory, e.g. add n/John Doe p/98765432 e/johnd@example.com b/100,000, it is clear that this will add a buyer with the name John Doe, as it is an input after the parameter n/ which stands for NAME in the instructions format, the phone number will be 98765432, etc...

Duplicate status (if any):

--