JunWei3112 / pe

0 stars 0 forks source link

The command format for "Adding an event" command is confusing #9

Open JunWei3112 opened 2 years ago

JunWei3112 commented 2 years ago

Screenshot 2021-11-12 at 5.11.39 PM.png

It is shown in the screenshot that an optional parameter called type can be included in the command here. However, no specification is made for this parameter and there is no details explaining how this parameter can be used. Including this optional parameter in the command does not work in the app as well. This will cause inconvenience for the users, and mislead them

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: It seems unreasonable that the team changed this to severity.VeryLow without providing an explanation. Bugs of severity.VeryLow are flaws that are purely cosmetic and does not affect usage. However, this will definitely affect the usage when readers are referring to this command format, when they want to know or recap on how to use the Adding an event command. As provided in my initial explanation, this will cause inconvenience for the readers since they may test this out in the app and find that including [type] in the command does not work at all. They may then be very confused, since no details are provided regarding this parameter in the command format too, which will cause quite some inconvenience to the readers. This is because they are now unsure of how this command works, or what parameters they should include in this command. The occurrence of this is also definitely more frequent than very rare situations, since the reader may often refer to this command format when they want to use this command to add an event.