-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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 tox #8423
Add codespell to tox #8423
Conversation
da543d5
to
59759d4
Compare
[codespell] | ||
ignore-words-list = ba,configurtion,ded,hel,perfom,wile | ||
skip = *.css,*.fjson,*.js,*.po,*.svg |
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 are only running this inside our docs for now, should be in docs/.codespellrc
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.
Codespell runs successfully across the entire repo.
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 it makes sense to run only for docs/
directory. That way we will reduce the execution time required. It seems the whole project takes +2 minutes to run otherwise, which is a lot: #8423 (comment)
Can you change this to run only on docs/
directory?
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.
Why does it make sense to ignore typos in other parts of the codebase?
The typos fixed in this PR are user-facing but they are not in docs/
.
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.
Oh, I think I missundertood your comment. tox -e lint
is the one that takes 2+ minutes. It seems that codespell
only takes 2s to run?
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.
codespell is really fast.
The tox jobs in CircleCI are sorted so the quickest jobs run first to provide fail-fast signals to contributors. Another approach would be to run the ~2m30s+ |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
I suggested changing the conf to only run on |
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.
Looks good to me!
@cclauss can you please solve the conflicts so we merge it?
ee3873c
to
f984ec0
Compare
f984ec0
to
3cbfdd8
Compare
7a82ab0
to
5c099ab
Compare
Add codespell to our
tox
testing to ensure that we do not have regressions on the typo fixes in #8409, #8419, #8420, and #8421.