Examples are used to substitute feature description

[pra-navi]

The 2 examples are used to simply show that the fields can be any order. This can be mentioned clearly rather then meant for users to infer from the 2 examples provided. So, not only is the description not clear enough but the example do not explain this feature of 'any order' well.

[nus-se-script]

Team's Response

It is already mentioned in the UG that parameters can be entered in any order as shown in the screenshot below.

We did not want to repeat the same point over and over and hence we put it once at the top of the features section.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: In that case, I would propose this to be Low (minor inconvenience in rare situations) Documentation Bug as there are too many redundant examples. If these 2 examples are not meant to show the interchangeability of the parameters then I do not understand the need for two examples here, a mere cosmetic issue but still one that could confuse readers. Personally, I spent a while trying to understand the difference between the first and the second example to see what was the value-added and if there was anything I should take note of. This was largely because the purpose of the examples were not explained well and only gave the direct input and output of the command.

this is the same in the other commands as well:

Instead of having 2 examples, both of which are only 1 parameters, a better example list could have been Examples: 1) Editing one parameter:

• edit_p 1 n\Joe Ng edits the name of 1st patient in the patient list to be Joe Ng . 2) Editing multiple parameters:
• edit_p 2 n\Joe Ng p\91234567 edits the name and the phone of the 2nd patient in the patient list to be Joe Ng and 91234567 respectively.

This is a clearer use of the examples feature for each command, and clearly explains the need for multiple examples if any (so 2 examples is justified for edit_p if they integrate it well with explanation, else 1 example is enough and wont confuse the readers).

---