-
Notifications
You must be signed in to change notification settings - Fork 196
Add a list of accepted "misspelled" words #1863
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
Conversation
|
at a glance this seems like more of a maintenance burden than it's worth. Why have this in CI, as opposed to part of the release procedure? |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
I have removed the spelling test to not gain an additional soft dependency. The idea here is to keep a list of words which we know to be acceptable words, so that we don't need to go through the list every single time we make a release. Currently, on main, devtools::spell_check() generates a huge list we need to go through to see which are truly misspelled words. If we add a list like the one in this PR, only the newly introduced, misspelled words will be flagged. This reduces maintainance burden for us. |
right but there will presumably be some churn, every time new documentation/vignettes are added there's likely to be some new words to add. happy to try it out for a few releases to see just how big that delta is each time though |
| io | ||
| jwz | ||
| knitr | ||
| labelled |
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.
labelled is British spelling, we should be consistent
inst/WORDLIST
Outdated
| eg | ||
| envvar | ||
| eval | ||
| favour |
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.
same, we should be consistent
inst/WORDLIST
Outdated
| alllowercase | ||
| backports | ||
| backticked | ||
| behaviour |
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.
another
inst/WORDLIST
Outdated
| debian | ||
| dplyr | ||
| dragosmg | ||
| eg |
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.
we should use e.g. consistently
inst/WORDLIST
Outdated
| rlang | ||
| roxygen | ||
| sandboxing | ||
| spilt |
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.
spilt is British
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.
This is going to be a tough one for someone like me who comes from the Commonwealth. 😅
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.
Just be happy we don't need to decide about metric units 😂
TBH I'm comfortable switching to en-UK too, but we should be consistent (do we have any function names assuming stateside spelling?).
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.
Thankfully, no, we don't have any function names that assume US spellings.
inst/WORDLIST
Outdated
| linter | ||
| linters | ||
| lintr's | ||
| localisation |
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.
one more 🇬🇧
inst/WORDLIST
Outdated
| nd | ||
| nodeset | ||
| nolint | ||
| parameterised |
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.
one more 🇬🇧
No description provided.