search

tituschewxj / pe

0 stars 0 forks source link

Optional paramters not correctly reflected in error messages #4

Open tituschewxj opened 2 months ago

tituschewxj commented 2 months ago

Current Behaviour

Example 1

The error message for adda does not correctly reflect optional parameters for att/ATTEND s/FEEDBACK_SCORE ad/APPOINTMENT_DESCRIPTION

image.png

But in the User Guide, the actual format of the message should be

image.png

Steps to reproduce

  1. Enter adda into the input bar

  2. Observe the parameters in error message.

Example 2

The error message for filter does not correctly reflect optional parameters for [sd/START_DATETIME] [ed/END_DATETIME].

image.png

But in the User Guide, the actual format of the message should be

image.png

Steps to reproduce

  1. Enter filter a into the input bar

  2. Observe the parameters in error message.

Expected Behaviour

The error message for adda should have these as optional: [att/ATTEND][s/FEEDBACK_SCORE] [ad/APPOINTMENT_DESCRIPTION]. Similiarly for filter.

Optional items should be wrapped with a bracket, as stated in the User Guide:

image.png

Why this is an issue

Not knowing if part of the input is optional or not directly from the application, makes it inconvenient for the user to perform commands, as they would have to cross reference the user guide.

I put this as a functionality bug instead of a documentation bug, because the actual behaviour is that these parameters are optional, so the behaviour differs from my expectations.

I put this a low, instead of very low, because this issue occurs across multiple command messages.

nus-pe-bot commented 2 months ago

Team's Response

We have downgraded this issue to VeryLow because it is a cosmetic error. While there is argument that the issue affects user understanding, the severity of the users misunderstanding that a parameter is optional when it is actually not is rather low, especially when it has already been mentioned in the user guide.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]