-
Notifications
You must be signed in to change notification settings - Fork 321
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
Fix typos found by codespell #1261
Conversation
@DimitriPapadopoulos want to add codespell to our CI config? |
I can do that if you're willing to live with the downsides:
|
One of the typo you identifed was in kitchen sink which is inherited from the sphinx-theme website. I reported it upstream. |
ooh, good catch. we shouldn't be modifying kitchen sink here. |
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.
instead of adding it to tests, would it be preferable to add it to the pre-commit ? they have a hook and this would make sure any commit is already checked + we are already checking the pre-commits in the tests
Yes, probably better in pre-commit. Unfortunately I don't have much experience with pre-commit, because of previous bad experience with it (lots of compatibility issues I didn't have time to debug on my Ubuntu 18.04 machine). I'll give it a try. |
Among other annoyances, pre-commit doesn't work on Ubuntu 22.04 by default:
Easily fixed with:
Buit then I get this new error:
I find pre-commit is a pain to use locally. |
let's roll back the CI addition and address adding codespell to pre-commit in a separate PR. No need to drag out the simpler changes. (please also revert the change to kitchen sink too, if you haven't already). |
I have reverted the CI/pre-commit stuff. |
No description provided.