search

aaronliwh / pe

0 stars 0 forks source link

unhelpstu command unclear description #14

Open aaronliwh opened 1 year ago

aaronliwh commented 1 year ago

image.png

The unhelpstu command is described as "will not change anything" when applied to a student with no help tag. This description is unclear, and in practice the application throws an error at the user.

This extends to other commands unmarkq and unmarktut, which have similarly vauge descriptions

soc-se-bot commented 1 year ago

Team's Response

Throwing an error does not change anything which is as mentioned in the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: "Will not change anything" does not sufficiently explain the behavior of the command when attempting to remove a non-existent help tag. It may be interpreted as "Will not have any response in the UI" , or "Will not result in any change to the application" , which would be untrue as an error message is thrown.

This bug qualifies as "Too brief". An adequate explanation would be " ... ... will not result in any changes to stored data, and will result in an error message being thrown"

:question: Issue severity

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

Reason for disagreement: This issue is not purely cosmetic, as it has bearing on the content of the user guide. Insufficient explanations may cause confusion to some readers, who will not know what to expect when attempting to remove a non-existent help tag.

image.png

This flaw causes minor inconvenience in very rare conditions, consistent with Low severity