-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: Spellcheck GH action #50
Conversation
4119f0a
to
ab36d90
Compare
38e5308
to
5745edd
Compare
ab36d90
to
297cbc9
Compare
IOPS | ||
InstanceType | ||
Postgres | ||
biganimal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should Biganimal be capitalized?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, spellchecker is not clever enough to distinguish when a word appears. This biganimal
is coming from
terraform {
required_providers {
biganimal = {
source = "biganimal"
version = "0.3.1"
}
}
}
And, with the current implementation, if we use biganimal
in, let's say, README.md, it will accept it. 🤷 not the best implementation, but I don't have any suggestions for fixing it. If you have, I'd love to hear.
And I've only added the words that the spellchecker was complaining about. Biganimal
wasn't one of them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
For more info on configuration, please visit https://facelessuser.github.io/pyspelling/configuration/ The spellcheck is only applied on the markdown files in the documentation.
71e2ff6
to
9d2b728
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR adds two checkers:
The
.wordlist-en-custom.txt
file is generated after the output of the spellchecker.Please review.
Related to #42. Please merge it after merging #49