search

JunWei3112 / pe

0 stars 0 forks source link

Error in the parameters shown in the error message for `policy` command #6

Open JunWei3112 opened 2 years ago

JunWei3112 commented 2 years ago

Screenshot 2021-11-12 at 4.52.17 PM.png

When users refer to this error message, they may think that they have to specify 'policy' instead of 'policy' as the command word, when they refer to the parameters. However, the actual behaviour is that 'policy' will not work, which may cause inconvenience to the users, since they are not sure as to why the given command parameters do not work.

nus-pe-bot commented 2 years ago

Team's Response

We accept this as a typo in the error message as funcionality bug. However, given that the error message shows an example as shown in the screenshot below:

image.png

and the User Guide clearly shows the command format

image.png

We believe that this will cause only a minor inconvenience because of the available resources.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Given that the user will use the policy command quite often, and they will often need to refer to this message for the command format, I believe that this is a Medium severity level bug, since a Low severity level bug appears only in very rare situations, which is not the case here. The team also said that the User Guide shows the correct command format, but the conflict between the two will definitely cause the users to be confused since they are unsure of which format to follow. Also, the team said that the user can refer to the example command provided in the error message. However, since the parameters do show a backquote with the policy command word, and this backquote can be seen in the example command too, users will be inclined to believe that the expected behaviour is that the policy command word should indeed be typed with a backquote. Furthermore, if the user was using the app without Internet (since it is stated in one of the NFRs of the team that the app is completely functional without the Internet), the user will not be able to access this user guide, since the team only provided a website link to their User Guide when the help command is executed. As such, the User Guide may not be available to them, and they only have this command format message to refer to at the time, which will cause some inconvenience.