search

ondretann / pe

0 stars 0 forks source link

Wrong/misleading error message for wrong parameter prefix #5

Open ondretann opened 6 months ago

ondretann commented 6 months ago

When entering a wrong parameter prefix for an add command, the output error message seems to be misleading or wrong.

Screenshot 2024-04-19 at 5.02.12 PM.png

As shown above, since "h/" is an invalid parameter prefix, an invalid command format message should be displayed. However, provided message is that contact index is invalid.

This will cause users to spend an extra amount of time trying to figure out the error in their command input, and lead them to believe that the contact index "1" is invalid.

nus-pe-bot commented 6 months ago

Team's Response

  1. Severity would be Low as the list of valid commands are provided in the User Guide, and this case is expected to be rare if user has read the UG.

image.png

Besides, because of the error section highlighting feature, it should be clear that the program is interpreting the whole 1 h/test as the index.

  1. This is also NotInScope because it would incur a significant additional implementation cost --- currently, the program only parse recognized prefixes.

    Items for the Tester to Verify

    :question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Clearly, this bug should be in scope since the wrong error message is output.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]