search

rainish2000 / pe

0 stars 0 forks source link

misleading error message for add_assessment #5

Open rainish2000 opened 2 years ago

rainish2000 commented 2 years ago

When there is an incorrect flag (here it is a/test2 instead of n/test2) the error output is misleading as it suggests that one of the actual values given are wrong, rather than the format of the command itself:

image.png

nus-se-bot commented 2 years ago

Team's Response

Duplicated as user input are parsed the same.

The 'Original' Bug

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

Error message does not match the error (less specific)

image.png

The error message for invalid format of the delimiter (/a) does not match the error / does not tell me that my delimiter is wrongly entered.

[original: nus-cs2113-AY2122S1/pe-interim#2265] [original labels: severity.Low type.FunctionalityBug]

Their Response to the 'Original' Bug

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

Ui format related.

This is not a bug. Error message is valid.

In the list_marks command, the parser first looks for the c/ parameter and the value associated to it will be CS2113T /aOP1. The parser prioritizes checking for invalid characters in the value before missing parameter(s) as parameters are processed in sequence. The error message is shown (in the image) as there is an illegal character / in CS2113T /aOP1.

Note: The parser does not look for / as a delimiter and different commands have different delimiters.

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: the original reorders the characters themselves which is bound to be misinterpreted by the program since it is technically a typo. My report attempts to show that just having the wrong flag, n/ instead of a/ (n/ is used for other things in the program after all, a simple slip of mind can always occur) could cause that output from the program when the actual parameters given have no illegal characters.

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I understand that the program works as explained in the response, but your program not checking the flags before splitting does not make it correct. If a user misremembers the flag for assessment a/ as n/ for assessment name instead, they get a misleading error message rather than something like "your format is incorrect".

:question: Issue severity

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

Reason for disagreement: continuing the above response, this is not just UI related and can cause inconvenience for the user scenario mentioned above, where they may waste time looking for an illegal character which does not exist instead of being immediately directed to the fact that the flag they have used is wrong.