search

narwhalsilent / pe

0 stars 0 forks source link

Wrong flag specified for `@` command in UG #14

Open narwhalsilent opened 6 months ago

narwhalsilent commented 6 months ago

The flag for file name is inconsistent in the UG, sometimes as /filename and sometimes as /file. image.png

This may greatly confuse the reader.

Improvement: Change UG to make sure it matches with product behaviour.

nus-pe-script commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Example given in the UG does not work

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.

I followed the example given in the UG.

image.png

but it was not a valid command.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#5144] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Thank you for pointing it out!

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)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is not a `severity.VeryLow` bug as it is not purely cosmetic. On the contrary, it affects the usage of the application as the user will be confused as to which prefix to use. Moreover, every user who reads this user guide will be confused and will need to test out which prefix is correct in the application. After that, they need to always keep in mind which prefix is the "correct" one when they refer back to the user guide. Therefore, this is a documentation bug that affects usage for all users, but users can continue using the product. I regard this as a bug which is between `Low` and `Medium` but leaning to `Medium`, because it is not rare (every user will encounter it), but it is not too bad to fix either.