Unmark command flag is inconsistent

[nus-pe-bot]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

UG header states that the unmark command is supposed to be -m, but the format specifies that the unmark command is supposed to be -u. Also, the example given states that it should be -m.

UG Header:

Format:

Example given:

---

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

[crvstalphua]

Team's Response

Thank you for the bug report!

There are two errors brought up here:

• error in the section header in UG
• error in the example command in the UG

Here we will mainly be addressing the first error, in line with the guidelines below:

We acknowledge that we did miss out the -u flag for unmark command in the command section header, however, since the command is correctly stated in the command format as well as the command summary (which contains the full list of commands), we believe that this error would only provide a slight inconvenience to the user as they would likely have read through the entire section before using the command. We believe the severity should therefore be "Low" instead of "High" as most users would read the entire section prior to use, leaving only a few users confused that can easily refer back to the paragraph written below, and also in the worst case users can still use the application as they can simply delete the issue or re-add the issue to mark it as incomplete; it therefore does not qualify for high. Although it is not the main issue we are addressing, the same can also be said with regards to the second issue, which is a typo in the unmark command example.

Duplicate status (if any):

--