Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possible framework for better errors with better documentation #1868

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christopherswenson
Copy link
Contributor

Very much a WIP at this stage

Basic idea is turn all error messages into objects with a code (e.g. invalid-pick/missing-else) and optionally some data.

Then, like with the previous work on this topic, that code is used in links to documentation.

Major difference is that all errors would be required to have a code. This allows us to force documentation to be up-to-date by ensuring that all error types are listed.

Thoughts:

  • This could also allow complicated errors to store multiple locations in them (e.g. "invalid [usage], defined [here]")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant