feat: add elaborators, completions, and hovers for named errors #8730
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit a3e4470.
github-actions
bot
added
the
toolchain-available
Collaborator
|
Mathlib CI status (docs):
|
nomeata
approved these changes
Jun 11, 2025
Co-authored-by: Joachim Breitner <[email protected]>
mhuisi
reviewed
Jun 16, 2025
Co-authored-by: Marc Huisinga <[email protected]>
Co-authored-by: Marc Huisinga <[email protected]>
Co-authored-by: Marc Huisinga <[email protected]>
mhuisi
reviewed
Jun 18, 2025
mhuisi
reviewed
Jun 18, 2025
Comment on lines
+89
to
+90
| logErrorAt id m!"There is no explanation associated with the name `{name}`. \ | ||
| Add an explanation of this error to the `Lean.ErrorExplanations` module." |
Contributor
There was a problem hiding this comment.
Could this error also suggest how to add an error explanation, or would that be too fragile? :-)
Contributor
Author
There was a problem hiding this comment.
I'll be adding a README with more detailed instructions to src/Lean/ErrorExplanations/ once I add that module (post-stage0 rebuild).
mhuisi
approved these changes
Jun 18, 2025
Contributor
mhuisi
left a comment
mhuisi
left a comment
There was a problem hiding this comment.
All of my remaining comments are nitpicks, feel free to merge as you see fit! :-)
Comment on lines
+23
to
+27
| /-- Example -/ | ||
| register_error_explanation TestDomain.Foo2 { | ||
| summary := "Error 2" | ||
| sinceVersion := "4.0.0" | ||
| } |
Contributor
There was a problem hiding this comment.
One thing I noticed when playing around with this and writing some test error explanation myself was that forgetting the docstring on register_error_explanation results in the following unhelpful error:
unexpected token 'register_error_explanation'; expected command
Contributor
Author
There was a problem hiding this comment.
Oh, good catch! Improving this will require a syntax change and re-bootstrapping, though, so probably best left to a separate PR.
algebraic-dev
pushed a commit
to algebraic-dev/lean4
that referenced
this pull request
Jun 18, 2025
…prover#8730) This PR adds support for throwing named errors with associated error explanations. In particular, it adds elaborators for the syntax defined in leanprover#8649, which use the error-explanation infrastructure added in leanprover#8651. This includes completions, hovers, and jump-to-definition for error names. Note that another stage0 rebuild will be required to define explanations using `register_error_explanation`. --------- Co-authored-by: Joachim Breitner <[email protected]> Co-authored-by: Marc Huisinga <[email protected]>
wkrozowski
pushed a commit
to wkrozowski/lean4
that referenced
this pull request
Jun 24, 2025
…prover#8730) This PR adds support for throwing named errors with associated error explanations. In particular, it adds elaborators for the syntax defined in leanprover#8649, which use the error-explanation infrastructure added in leanprover#8651. This includes completions, hovers, and jump-to-definition for error names. Note that another stage0 rebuild will be required to define explanations using `register_error_explanation`. --------- Co-authored-by: Joachim Breitner <[email protected]> Co-authored-by: Marc Huisinga <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR adds support for throwing named errors with associated error explanations. In particular, it adds elaborators for the syntax defined in #8649, which use the error-explanation infrastructure added in #8651. This includes completions, hovers, and jump-to-definition for error names.
Note that another stage0 rebuild will be required to define explanations using
register_error_explanation.