search

heejet / pe

0 stars 0 forks source link

Format of error messages distracting. #2

Open heejet opened 1 year ago

heejet commented 1 year ago

The output for error messages are quite distracting with the excessing exclamation marks.

To recreate this press ctrl + c in the main mode.

I think you can cut down on the use of the exclamation mark so that the user can focus on the error message instead of getting distracted by the text around it.

image.png

soc-pe-bot commented 1 year ago

Team's Response

Thank you for the report!

Unfortunately, after much deliberation we have decided to reject this bug that you have issued.

Firstly, the line separators for error messages are purposely designed with exclamation marks to visually alert users that the input is invalid. This is purposely differentiated from normal output message line separators so that users will pay additional attention to this error message. The use of exclamation marks in the line separator has effectively alerted that Ctrl + C is an invalid command.

Secondly, exclamation marks are only used as separators. Hence, it does not affect the readability of the error messages. Additionally, with the help of indicators ("Error Message" and "Note"), users can read and interpret the error messages easily.

As such we hope you understand why we are rejecting this issue.

We hope this clarifies, thank you!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I hear your point but I have to disagree. I acknowledge that the message can still be read (albeit with some difficulty) and this is precisely why I marked this as a cosmetic bug, giving it a severity of very low.

After reading your reply, I still feel that the excessive use of the exclamation mark is quite distracting to the user. I agree that a visual alert is needed but I think that there are many better ways to go about doing it. Since your application a very close reference to unix style CLI apps, I have provided an example error message from git (which you shown in your DG).

image.png

To conclude, I hear your point that the message is still readable but the style which you displayed the message is not conducive for reading therefore it is a cosmetic issue giving it a severity of very low.