Open nus-se-script opened 1 week ago
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...
--
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 likefind
, there is further elaboration what the command does in the examples section.Add command:
Find command:
[original: nus-cs2103-AY2425S1/pe-interim#1448] [original labels: severity.Medium type.DocumentationBug]