Edit command requires multiple instances of same prefix which contradicts instruction in UG about pe

[nus-pe-bot]

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Multiple parameter example misleading

In the UG in the "Notes about the command format section", there is an explanation of what happens if multiple of the same parameter is included when only one is expected. However the example provided (phone number p/) is an example where the parameter is expected multiple times (in the edit command), so the example can be misleading.

---

_{[original: nus-cs2103-AY2223S1/pe-interim#355] [original labels: type.DocumentationBug severity.Low]}

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

In the UG in the "Notes about the command format section", the explanation clearly expressed "If a parameter is expected only once ...". Thus it does not apply to edit command.

The example provided is merely a demonstration of a same parameter being specified twice, it has nothing to do with edit command (or any specific command, for that matter).

Items for the Tester to Verify

❓ Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

• I disagree

Reason for disagreement: [replace this with your explanation]

---

❓ Issue response

Team chose [response.Rejected]

• I disagree

Reason for disagreement: I've accidentally reported this problem twice. The response below is the same as the one I've left on the original issue

---

Yes I don't dispute that the instruction does not apply to the edit command. But the problem is that the example chosen just happens to feature a parameter that can appear twice in an edit command. Perhaps the developers don't intend for the instruction to have anything to do with the edit command, but the reader may not realise this to be the case. Hence, it can cause confusion to the reader as they may be wondering why later on the phone parameter is being included twice in a command, like in the example of the edit command in this screenshot:

Instead, it would have been better if another parameter was chosen as an example instead, one that only ever appears once in a command

---