Edit command summary example does not work

[kevin9foong]

Missing spaces hence does not work

This can cause a lot of confusion to the user and prevent them from knowing how to execute the edit command

On the other hand, some other commands eg. Delete contain the required spaces (hence there is an inconsistency)

[nus-pe-bot]

Team's Response

The example stated in UG is clear that there should be a space in between all prefixes. Format of edit command is stated in UG as well.

The problem may be due to a formatting issue caused by copy-pasting. However, users are expected to type out the command themselves, and not copy from anywhere (while they can, they should be aware of the command format)

The 'Original' Bug

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

space between command name and parameters not captured when copied

Documentation copying in PDF doesnt copy command spaces between, for example, add and parameter n/Amy Tan, hard to copy commands for testing

---

_{[original: nus-cs2103-AY2122S1/pe-interim#3939] [original labels: severity.VeryLow type.DocumentationBug]}

Their Response to the 'Original' Bug

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

This is an issue related to pdf viewer. The command is correct and user should be able to reproduce the command in the program.

Items for the Tester to Verify

:question: 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]

---

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: I disagree that this should be rejected since the team's response does not address the reported bug that the edit command summary's example is incorrect.

Even though the edit command section in the UG explains the use of the edit command, it is still expected that the command summary section of the UG (which is a separate section in the UG) should provide a correct example for the readers who use it.

For example, since readers are likely to reference the command summary without looking at the edit section when entering commands.

Additionally, this is not a formatting issue due to copy-pasting, since the command summary example provided does not have spaces in the pdf as shown in the screenshot below.

In the event this is a pdf conversion related bug, this still does not mean it should not be considered a bug according to the module website, since incorrect command examples are very likely to hinder the reader and examples are expected to work when input into the program.

This is evidenced by the module website which states that pdf conversion bugs that hinder the reader are still considered valid bugs.

---

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

• [x] I disagree

Reason for disagreement: This should not be marked as VeryLow since it is not merely a cosmetic issue.

If a command example is incorrect, it would lead to users being unable to run the example commands which is not purely cosmetic. This is also evidenced by the CS2103T pe quiz which shows a relevant example of how an incorrect example can be considered a medium level bug and should not be marked as cosmetic.

Due to incorrect example, the user is unable to run the command listed - similar to this reported bug.

Hence, this bug should not be considered severity.VeryLow as it is not a cosmetic issue.

---