Errors should have links to further information

[simonw]

Inspired by this tweet:
https://twitter.com/willmcgugan/status/1381186384510255104

While I am thinking about faqs. I’d also like to add short URLs to Rich exceptions.

I loath cryptic error messages, and I’ve created a fair few myself. In Rich I’ve tried to make them as plain English as possible. But...

would be great if every error message linked to a page that explains the error in detail and offers fixes.

[simonw]

I could have a page about error codes in the docs, then have https://datasette.io/E123 style URLs for each error core which are shown when that error occurs and redirect to the corresponding documentation section.

Can enforce these with a documentation unit test.

[simonw]

Related:

• Figure out design for JSON errors (consider RFC 7807) #1875