Li-Lehao / pe

0 stars 0 forks source link

Speciticity of error message #2

Open Li-Lehao opened 2 years ago

Li-Lehao commented 2 years ago

steps to reproduce: type this command add n/John Doe p/98765432 e/johnd@example.com g/4.50 i/NTU c/Computer Science j/Software Engineer into the text box and press enter

Expected: the error message should show why the command is invalid instead of just showing that the command is invalid

Actual: the error message does not provide which filed is missing and it's very long and hard to read.

Screenshot

image.png

nus-pe-bot commented 2 years ago

Team's Response

Duplicate of #817

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Specificity of error message can be better

[Description] When an invalid argument is being supplied, error message returned is too generic.

[Steps to Reproduce]

  1. edit 1 grad/ 234234

[Expected] Expected an error message to be thrown stating that invalid argument supplied or "grad/" is not a valid argument.

[Actual] Generic error message of "Invalid command format!" returned.

[Screenshot]

image.png


[original: nus-cs2103-AY2122S1/pe-interim#781] [original labels: severity.Low type.FeatureFlaw]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The error message is sufficient to let the users know that the command format is wrong.

To check specifically for wrong prefixes is not trivial and we already have error message for incorrect field input. image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: Thanks for your reply.

I disagree that this is a duplicate bug. The original bug and the bug I reported are all about the specificity of error message, however, I think that they are not the same. The original bug use the command edit 1 grad/ 123 but the grad/ is not a valid field. In this situation, I think the error message Invalid command format is correct and the team's response makes sense. However, in my bug report, I used the add command with a missing field. As we know the command is extremely long in this design and has a lot of parameters. The user especially the new user might forget to put in one or more fields. This very general error message invalid command format cannot help them find the missing fields, and it might make them more confused since the input parameter is correct but the software says invalid command.

Therefore I think this is not a duplicate bug since the original bug report might not make sense, but the bug I reported is an issue that usually happens and causes some slight inconvenience.

Therefore I think the bug I reported should be considered a feature flaw and the severity is low.


:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: In my bug report, I used the add command with a missing field. As we know the command is extremely long in this design and has a lot of parameters. The user especially the new user might forget to put in one or more fields. This very general error message invalid command format cannot help them find the missing fields, and it might make them more confused since the input parameter is correct but the software says invalid command.This is an issue that usually happens and causes some slight inconvenience.

Therefore I think the bug I reported should be considered a feature flaw and the severity is low.