JamesLiuZX / pe

0 stars 0 forks source link

Non-specific error logging #12

Open JamesLiuZX opened 1 year ago

JamesLiuZX commented 1 year ago

Minor gripe but when I input an invalid character in delete, it clutters the entire result logging box with 8 lines of format and general delete error messages. It would be great if it could be like this:

Screenshot 2023-04-14 at 3.16.31 PM.png

Screenshot 2023-04-14 at 3.15.02 PM.png

soc-se-bot commented 1 year ago

Team's Response

Rejected. This is not a documentation flaw. In our error message, we feel it is important to tell the user what they can do succinctly, so we tell the users what parameters to use for delete, and what parameters are accepted.

For example, delete sd/... tells the user they are free to use start date.

Providing specific examples alone may not inform the user well enough (not useful), and providing so many examples on top of general descriptions will clog up the dialogue box even further. We feel it is important to just provide the general description, and users can refer to the help menu or user guide for further clarifications/examples.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for the reply, but I am not talking about the result box having the format of a delete inside, I'm talking about the specificity of error message. You're telling the user with 8 entire lines every possible case of erroneous input such as ("Indexes cannot occur with dates, and a single date cannot occur with a start or end date..."), when as an inexperienced user I just want to know either 1. it contains an invalid symbol/character 2. what the format is, which should take 2-4 lines maximum, instead of 8 lines detailed every possible case of error.