cadence icon indicating copy to clipboard operation
cadence copied to clipboard

Improve error messages

Open turbolent opened this issue 2 years ago • 1 comments

Issue To Be Solved

Error messages are often sparse and unhelpful.

Suggested Solution

  • Extend error messages with more detail
  • Provide example errors and explain them
  • Provide suggestions for how to fix the error
  • Link to documentation
  • Link to page with more detail for given error

High priority errors:

  • InvalidTransactionAuthorizerCountError
  • ConformanceError
  • Your unintelligible error here

Inspiration:

  • https://wix-ux.com/when-life-gives-you-lemons-write-better-error-messages-46c5223e1a2f
  • https://elm-lang.org/news/compiler-errors-for-humans
  • https://github.com/mattpocock/ts-error-translator
  • https://typescript.tv/errors/
  • https://blog.rust-lang.org/2016/08/10/Shape-of-errors-to-come.html

turbolent avatar Oct 11 '22 17:10 turbolent

This would be tremendous!

Frequently what part of the stack has the error lies and options for a solution are difficult to find.

Adding more detailed error messages with links to documentation with even more detail about what causes the error and potential solutions would benefit the whole ecosystem.

SeanRobb avatar Oct 13 '22 23:10 SeanRobb