williamlamjy / pe

0 stars 0 forks source link

Inconsistent error messages for weight #6

Open williamlamjy opened 2 years ago

williamlamjy commented 2 years ago

Screenshot 2021-11-12 at 4.29.26 PM.png

Unknown error is vague, what if mistyped an additional spacing before adding my weight but do not know what is the issue? Also the second invalid input should show the same message as the first

soc-pe-bot commented 2 years ago

Team's Response

The invalid input has been caught for both inputs and these two inputs have a different error and thus warrant a different error message (For the difference between your first and second error message).

As directed in the error message, the help commands function will provide you with useful information on what is lacking/wrong with your input. This command also links to our user guide that you have followed which also includes a sample input to guide you for your own inputs.

As shown below, code output for help commands:

image.png

image.png

image.png

Our user guide:

image.png

On your issue of an additional spacing, you can always try retyping.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As much as this is addressed in the user guide, there should still be a more specific error message to mention no spaces in the weight parameter instead of "Unknown error" which could be very vague to the user.


:question: Issue severity

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

Reason for disagreement: Very low indicates appearance/aesthetic issues. This bug will cause inconveniences when the user mistypes and requires guidance, however there is none.