huixuant / pe

0 stars 0 forks source link

Inaccurate error message for event command #2

Open huixuant opened 1 year ago

huixuant commented 1 year ago

[Actual] When a user enters the event command without add, delete or find, the error message shown is not specific enough/inaccurate.

image.png

Referencing the error messages thrown for the other commands, a valid command like add with invalid/missing parameters shows the error message below.

image.png

For other invalid commands, the error message thrown looks like this.

image.png

[Expected] The message should inform the users that event is not a valid command, and suggest that they use event add, event find or event delete instead.

nus-pe-script commented 1 year ago

Team's Response

As the event becomes a command without any sub-commands, the error message is not incorrect. But we agree it could be more descriptive.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I disagree with the team's re-assignment of the severity of this issue.

As stated on the module website, issues that are labelled with severity.veryLow should be reserved exclusively for cosmetic issues. However, this issue warrants more than a cosmetic improvement, since it is related to the accuracy and/or specificity of the error message shown to the user.

To prove my point, a similar example with respect to inaccurate error messages that is given on the module website also assigns such issues with severity.Low.

image.png

Therefore, I stand my ground that this issue should remain as severity.Low.