nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Error statement for adding recipe are not specific in telling the user what was wrong #266

Open nus-pe-bot opened 2 days ago

nus-pe-bot commented 2 days ago

The error statement given to users when they add a recipe with invalid arguments is generic and does not show the user what was wrong. It does not specify which argument was invalid, whether it was a formatting error, multiple flags, etc.

image.png

This can be extremely frustrating for users, using the add recipe command, as this command is meant to be extremely long, detailing every single step and ingredient of an entire recipe. An example of a user trying to add a recipe with more verbose steps, but having small error is shown below for reference:

image.png

In the above example, the error was that a 'i/' ingredient flag was specified out of order. It is extremely hard for a user to be able to find where their error was in the large amount of text printed as part of the error message. This can lead to frustration as the user does not know where the error is, or how to fix their command, limiting the usefulness of the product.


[original: nus-cs2113-AY2425S1/pe-interim#59] [original labels: severity.Medium type.FeatureFlaw]

KSanjith commented 1 day ago

Team's Response

Dear Tester, we would like to label your issue as NotInScope, and lower it's severity to Low.

We agree that the error statement could be clearer in terms of pointing out which part of the command is wrong, but we strongly disagree that this is a Medium severity. We feel that it should be a Low severity instead. And based on the course wesbite, the specificity of error messages can be considered Low severity.

Furthermore, to allow for such specific error messaged for the add command, would require massive work done to our parser to identify all offending arguments, interpret the user intention, and display a highly specialised error message, which would take a considerable effort and time to do. Therefore we feel that this bug qualifies as NotInScope.

image.png

image.png

Duplicate status (if any):

--