-
Notifications
You must be signed in to change notification settings - Fork 5.3k
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 to pre-commit hooks and fix spelling of existing files #1161
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1161 +/- ##
===========================================
+ Coverage 30.59% 49.08% +18.49%
===========================================
Files 30 30
Lines 4256 4256
Branches 983 1034 +51
===========================================
+ Hits 1302 2089 +787
+ Misses 2861 1968 -893
- Partials 93 199 +106
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Adding codespell to pre-commit catches 139 spelling errors. Most of them are actual misspellings but a few are not, like Empress, which codespell wants to change to Impress. Would this force us to explicitly exclude certain files from codespell in pre-commit-config.yaml? |
…s and a few minor bugs in the code
@rickyloynd-microsoft I fixed most spelling errors and then excluded the whole notebook directory from checking. There are some utf-8 encoded parts that confuse codespell. Not perfect, but better than nothing. |
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.
After exclusion of the notebooks, I see no problems with codespell's other changes. I defer to Chi on whether to add codespell to pre-commit.
…icrosoft#1161) * fixed spelling, minor errors and reformatted using black * polishing * added codespell to pre-commit hooks, fixed a number of spelling errors and a few minor bugs in the code * update autogen library version in notebooks * update autogen library version in notebooks * update autogen library version in notebooks * update autogen library version in notebooks * update autogen library version in notebooks
Why are these changes needed?
There is a large number of typos and spelling errors in the repository that could have been easily caught by a spelling checker. This PR Integrates the
codespell
tool as apre-commit
hook and scan changed files for spelling errors.Existing spelling errors are also fixed.
Related issue number
Closes #1162
Checks