Improve Vale spellcheck #500
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
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
In #475 it was noticed that typos of
CompositeResourceDefinitionaren't flagged by Vale.As described in Vale #527 the default spellcheck ignores words with multiple caps in the word, assuming it's covered by something else.
We don't have an easy way to check for any misspelling of a
kindlike CompositeResourceDefinition.Good News:
This PR fixes it and makes the spell checker more sensitive and it catches any error like this (and some others we had previously missed)
Bad News
It makes the spell checker more sensitive. It not picks up errors with links in line breaks and a few other conditions described in the Contributor guide updates that are part of this PR. Going forward I expect a small uptick in the work we have to do in order to keep the spelling exceptions updated.
Resolves #490
Signed-off-by: Pete Lumbis pete@upbound.io