search

paing-oo / pe

0 stars 0 forks source link

UG documentation error for `list` command #4

Open paing-oo opened 2 years ago

paing-oo commented 2 years ago

Description of flags stated that they are used to "delete" which is not the intended use of the command.

image.png

nus-pe-bot commented 2 years ago

Team's Response

While we agree this is a bug, the explanation is not crucial for understanding how the command works. The words in the highlighted section is explaining the usage of flags, and are repeated multiple times throughout the entire user guide (in add / edit / delete) etc. The user should not be confused with the usage of list, given that the command format is stated above the highlighted section. In particular, this highlighted portion has no bearing on how the list command should be used, and is a typo instead and does not inconvenience the reader.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: First of, the severity should not be VeryLow as VeryLow severity is only used to categorize cosmetic bug.

Secondly, as the flags are used in every command, a wrong description of them would result in inconvenience of the user. Moreover, all the flags have wrong description, not just one flag. Hence severity should be medium as this flaw could affect normal operations of the product.

image.png