-
Notifications
You must be signed in to change notification settings - Fork 544
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
Add codespell as a linter #5265
Conversation
Similar to rapidsai/cudf#12097, this adds codespell as a linter to the pre-commit config, and fixes various spelling errors it highlights. (https://github.com/codespell-project/codespell)
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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.
Very nice! I like that we can use this pre-commit hook to more easily avoid these kind of common mistakes in the future.
I went through all changes and found a few spurious and wrong ones, I would appreciate if you could address those.
Further, I think it would be good to add a summary of the hooks' purpose to the contributor guide here. It would also be great to have a brief note with guidance on how to disable the check for specific words or lines.
Co-authored-by: Carl Simon Adorf <[email protected]>
and comments to the codespell config describing what the options do
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.
Great, thanks for addressing the review comments so quickly. It would still be nice if you could add a note about how to ignore certain suggestion (# noqa
?) to the contributor guide, otherwise LGTM!
thanks @csadorf ! I've added some text about how to ignore suggestions in the last commit |
/merge |
Similar to rapidsai/cudf#12097, this adds codespell as a linter to the pre-commit config, and fixes various spelling errors it highlights. (https://github.com/codespell-project/codespell)