Add codespell to pre-commit hooks #718
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
This catches and fixes several typos. Also, fix 'mutabl->mutable' in docs, which was not caught by codespell.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
kurtmckee
approved these changes
Apr 17, 2023
There was a problem hiding this comment.
- Love that you wrote "codepsell" more often than "codespell" in this PR! 馃槈
- The
typosproject seems to catch more typos thancodespellcurrently does. I recommend taking a look at that instead! (For example,typoscaught "StorageGatewayDocumment" and updated it to "StorageGatewayDocument".)
馃う
Yeah, I'm happy to swap this out in the future (as in, within the hour) if we try it out and like it better. |
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.
This catches and fixes several typos.
Also, fix 'mutabl->mutable' in docs, which was not caught by codespell.
(For reference, I've tried opening a PR on codepsell, to see how hard or easy it is to get our relevant typos included there as we encounter things.)
Some background/meta: codepsell lists known words and typos, to keep false negatives to a minimum. For some problem-words like
dequevsdequeue, it features a few different built-in dictionaries which we could apply.I'd like to try it out here and on the CLI, and maybe replace the custom typo checker I wrote for one of our internal projects with it.
馃摎 Documentation preview 馃摎: https://globus-sdk-python--718.org.readthedocs.build/en/718/