johnnythesnake12 / pe

0 stars 0 forks source link

Command is add-tag but documented as add tag here #6

Open johnnythesnake12 opened 11 months ago

johnnythesnake12 commented 11 months ago

On page 19 of UG:

" If the tag prefix is specified, all existing tags under the employee will be removed and replaced with the new tags in the command. In the first example, the employee will have all tags removed and replaced by 2 tags: full-time and remote. In the second example, the employee will have all tags removed. No tags will be added since no tags are specified. Therefore, to avoid unintentionally losing any information while editing tags, we recommend using the add tag and delete-tag commands instead for editing tags."

While it is still understandable that add tag should be add-tag here, it is a command nonetheless which might confuse users.

nus-pe-bot commented 11 months ago

Team's Response

Accepted, thank you.

However, this is a small typo, a cosmetic issue, that does not affect the reader's understanding of the user guide. Therefore we will be downgrading it to a very low severity.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: if it was a normal typo such as "father-in-law" being spelled as "father in law", I would agree that it is just a cosmetic issue. However, in this case, the typo concerns one of the team's commands, hence it should not be of very low severity.