narwhalsilent / pe

0 stars 0 forks source link

Incomplete error message for `tag+` command #11

Open narwhalsilent opened 4 months ago

narwhalsilent commented 4 months ago

Way to reproduce: tag+ a-b

Expected: Tags names should be alphanumeric (i.e. no whitespace characters or special characters).

Actual: image.png

Explanation: The "i.e." part of the error message is incomplete, because having no whitespace characters is not the same as alphanumeric. From the behaviour it seems that special characters are not accepted too. This should be clearly stated or it might confuse the user as to what is allowed in tag name.

nus-pe-script commented 4 months ago

Team's Response

We believe that with the phrasing, 'should be alphanumeric', that non-alphanumeric characters are not allowed.

We use the i.e to emphasise the whitespace character as it can be ambiguous in some applications, whereas special characters are clearly non-alphanumeric characters which we have already stated. In this sense, there is no inaccuracy or incompleteness in our error message.

Thank you for pointing it out!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I note that the Latin contraction "i.e." means "that is", which means that the two phrases before and after are equivalent.

image.png

In the case of the screenshot in the original bug report, "alphanumeric" is not equivalent to "no whitespace characters", so it is inaccurate to use "i.e." in this context.

Therefore this is a bug which should not be rejected.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a `severity.VeryLow` bug because although it is grammatical, it impedes understanding and usage of the user. This is because the user is left unsure which between "alphanumeric" and "no whitespace characters" is accurate due to the usage of "i.e.". Hence, the user will have to test whether "-" is allowed in in tag names, which impacts usage. Hence it should be `severity.Low`.