-
Notifications
You must be signed in to change notification settings - Fork 107
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 spelling/typo linter and fix errors #556
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
👈 Launch a binder notebook on this branch for commit 47f20b3 I will automatically update this comment whenever this PR is modified 👈 Launch a binder notebook on this branch for commit b23c999 👈 Launch a binder notebook on this branch for commit 72415ac 👈 Launch a binder notebook on this branch for commit 3ec08c1 👈 Launch a binder notebook on this branch for commit be9954f 👈 Launch a binder notebook on this branch for commit 2ef15d1 👈 Launch a binder notebook on this branch for commit cbd8def 👈 Launch a binder notebook on this branch for commit b1e01c1 👈 Launch a binder notebook on this branch for commit 0512d2f 👈 Launch a binder notebook on this branch for commit 9986b95 |
Awesome, thank you for this! What do you think of adding codespell as a pre-commit check? |
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!
[tool.codespell] | ||
ignore-words-list = "aas,socio-economic,toi" | ||
|
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.
I think there was talk about alphabetizing within pyproject.toml
, which I'd be in support of so it's easier to find if a given tool is already there.
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.
- Validate pyproject.toml #557 originally contained https://github.com/tox-dev/pyproject-fmt to automate organizing that file but it was requested to be reverted back out.
setuptools
is so central to Python packaging that I have always seen it before all other tools so that is why I placed codespell
just after it.
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.
Thanks for the explanation! Totally makes sense on the order then.
it was requested to be reverted back out.
So then is #557 needed?
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.
#557 is still providing a validator even though the formatting part of it was removed 🚀
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.
My inner editor is very excited about this PR!
Thanks @cclauss 🚀 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #556 +/- ##
============================================
Coverage 65.07% 65.07%
============================================
Files 36 36
Lines 3052 3052
Branches 538 538
============================================
Hits 1986 1986
Misses 981 981
Partials 85 85 ☔ View full report in Codecov by Sentry. |
https://pypi.org/project/codespell
%
codespell --ignore-words-list=aas,socio-economic,toi
%
codespell --ignore-words-list=aas,socio-economic,toi --write-changes