search

tamagochuuu / pe

0 stars 0 forks source link

[UG] Example command given in the command summary does not work. #7

Open tamagochuuu opened 6 months ago

tamagochuuu commented 6 months ago

Example command given for addmempts in the command summary of the UG: image.png

When the command is called using an existing contact 'Alex Yeoh': image.png

The example command given in the command summary does not work and instead displays an error message. This can cause major inconvenience to users as users visit the command summary to quickly get information they need on the available commands, and hence it is important that the section is accurate.

Furthermore, even though the error message redirects the user to the list of available commands, there is no information to tell the user what went wrong when they called the addmempts command.

nus-pe-bot commented 6 months ago

Team's Response

Thanks for finding this!

However, we feel that this is just a typo and that other mentions of addmempts have working examples. The section that describes this command also has the correct prefix "mp/"

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: While it is true that other mentions of addmempts have working examples, I feel that this typo in particular still causes users inconvenience that is not minor. This is because I feel that the command summary section is there so that users don't have to read through the other sections of the UG when they need quick information about a certain command. This typo is rather drastic, having both the wrong prefix ms/ instead of mp/ and an invalid input paremeter T2 which is not an integer, and hence the user cannot easily figure out what the correct command is supposed to be. Then they would have to go search in other sections of the UG for the correct command. This can cause great inconvenience to the user especially when the user is trying to addmempts after a customer has made a purchase during a busy period where there are many customers waiting to buy baked goods, and the user is trying to quickly get the adding of membership points done and attend to another customer. Hence I feel that it is important for the command summary section to be completely accurate as bugs like this cause great inconvenience to users. Hence I think the severity should be Medium.