Possible framework for better errors with better documentation #1868
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: