search

jedidiahC / pe

0 stars 0 forks source link

No mention of the /tag prefix anywhere in the User Guide except for the "List of Prefixes" section #8

Open jedidiahC opened 1 year ago

jedidiahC commented 1 year ago

Although the user is actually able to add/edit tags to students in commands such as new-exam, the /tag prefix is not mentioned anywhere in the User Guide even in commands such as new-exam.

image.png

No mention of /tag in the command format for new-exam.

image.png

Hence, the /tag prefix is undocumented functionality that may confuse the user.

For example, how does the user remove tags?

soc-pe-bot commented 1 year ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Tags are not used in the new-exam command. The problem description is unclear.

While tags do exist in the list of prefixes, which is a typo on our end, it is not mentioned in the command formats, so it will not really impact the users enough to be a Medium severity bug. We propose it to be a Low severity DocumentationBug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: [replace this with your reason]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]