Tweak the grammar of DiffErrStrings outputs #140
Merged
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
The previous output is slightly problematic because it contains grammatical ambigity that is only resolved after the first error message is printed. It's a [Garden-path sentence](https://en.wikipedia.org/wiki/Garden-path_sentence). When an error message is large, the user sees `expected error wall_of_text.....`. The obvious mental parsing of this is incorrect: "[we] expected [the] error [to be] wall_of_text". Once the user finds the remainder of the message after the wall of text, they find out that their mental parse tree should actually be "[we] expected [that the] error [we got, which was] <wall of text>...". The problem is exacerbated for large error messages where the sentence structure is not visible at a glance.
sethvargo
approved these changes
Jun 15, 2023
pdewilde
approved these changes
Jun 15, 2023
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.
The previous output is slightly problematic because it contains grammatical ambigity that is only resolved after the first error message is printed. It's a Garden-path sentence.
When an error message is large, the user sees
expected error <wall of text>...... The obvious mental parsing of this is incorrect: "[we] expected [the] error [to be] ". Once the user finds the remainder of the message after the wall of text, they find out that their mental parse tree should actually be "[we] expected [that the actual] error [we got which was] ...". The problem is exacerbated for large error messages where the sentence structure is not visible at a glance.