Skip to content

Display more informative and actionable error messages

Nate Graham requested to merge ngraham/kinfocenter:better-error-messages into master

These error messages were a bit short and contained technical jargon. They did not give the user a good sense of how to proceed.

With this commit, the error messages are changed to clearly include the important elements of a good error message:

  1. What went wrong
  2. Why it happened
  3. How they can fix it themselves
  4. How they can report the issue to get it permanently fixed for everyone

To do this, the setError() function is extended to also be able to accept optional explanation and bugReportUrl arguments, which are used to present better information to the user.

@teams/vdg @teams/usability

Before After
"Tool not found" error message Tool_not_found__before Tool_not_found__after
"Tool crashed" error message Tool_crashed__before Tool_crashed__after

Merge request reports