search

clarud / pe

0 stars 0 forks source link

Wrong error thrown for findc command #2

Open clarud opened 2 weeks ago

clarud commented 2 weeks ago

image.png

As stated in the UG as shown below,

image.png

This command finds concerts whose names contain any of the given keywords. However, when I run into an error when inputting the name for the command, a wrong command is given to me. I believe I am supposed to get an error message telling me how I should instead edit my name field in my findc command, however, I get an invalid name format error. It further states that values such as 's/o' is able to be inputted which doesn't make sense in this case as this is a concert name. Also, in the error message, the example given is that of a person name not a concert name.

As a user, it is quite possible to run into this error as they might type in an empty field to find out what they should be inputting. However, the error thrown may mislead them to think that having 's/o' is correct. Also the mismatch between the error thrown here may confuse them as it is as though it is a person name instead of a concert name.

Even though concert name and person name might have similar constraints, throwing a person name error here is very misleading.

Recreate error:

  1. findc n/
nus-se-script commented 2 weeks ago

Team's Response

Hi, thanks for the feedback! We believe that you may have accidentally misread the error message shown. The error message that you have provided is the error message you were expecting to receive (invalid name field provided).

image.png

In the error message, we inform users that they have inputted an Invalid name format and we also provided the constraints that the name field have.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Hi thank you for your response. However, I would have to disagree with your point. You mentioned that "we inform users that they have inputted an Invalid name format and we also provided the constraints that the name field have", implying that the error message is correct.

image.png

image.png

Even though it is an invalid name format, I find a few issues with the error message. For context, this command is used to find a concert based on the concert's name (e.g Coachella)

  1. The error message states allowing usage of 's/o' and 'd/o' exclusively which implies that this might be a person name field instead. It is unlikely for concert names to have these.
  2. The example given in the error message is "n/John Doe s/o Jane Doe" which further uses the s/o example. Other than that it is also very unlikely that 'John Doe s/o Jane Doe' is a concert name.

With these 2 points in mind, I would think that it might cause confusion to users. One scenario is when the user inputs a wrong value and this error message is thrown. They will see the mismatched constraints and examples and try to see if it works.

image.png They will be further thrown with the same error.

These points suggest that the error message is not aligned with the actual use case of the command. Instead of helping users understand and correct their input, the message might lead to more frustration and uncertainty.