Get rid of uninformative generic notes for higher-order contract errors #1564
Conversation
This file contains 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
Upon the failure of a higher-order contracts, we used to include quite generic notes showing a plain illustration of the kind of higher-order violation that happened. However, this text was totally generic (the example didn't relate to the source code at all), quite verbose (around 4-5 lines of notes), and to be honest, not very helpful. We now have good mechanisms to underline the right part of the function contract that failed, together with customized label (e.g. "broken by the caller"), which makes look like the original generic note aren't very valuable. This patch ditches those notes altogether.
jneem
approved these changes
Sep 1, 2023
suimong
pushed a commit
to suimong/nickel
that referenced
this pull request
Sep 17, 2023
Upon the failure of a higher-order contracts, we used to include quite generic notes showing a plain illustration of the kind of higher-order violation that happened. However, this text was totally generic (the example didn't relate to the source code at all), quite verbose (around 4-5 lines of notes), and to be honest, not very helpful. We now have good mechanisms to underline the right part of the function contract that failed, together with customized label (e.g. "broken by the caller"), which makes look like the original generic note aren't very valuable. This patch ditches those notes altogether.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Upon the failure of a higher-order contract, we used to include quite generic notes showing a plain illustration of the kind of higher-order violation that happened. However, this text was totally generic (the example didn't relate to the source code at all), quite verbose (around 4-5 lines of notes), and to be honest, not very helpful.
We now have good mechanisms to point at the right part of the function contract that failed, together with customized label (e.g. "broken by the caller"), which feel like the original generic notes aren't very valuable anymore.
This patch ditches those notes altogether in the error messages, making them smaller.