Add codespell support (config, workflow to detect/not fix) and make it fix few typos #1126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
thanks a lot @yarikoptic ! no objections on my side, seems like a nice addition but I don't have experience with codespell, maybe @glemaitre has an opinion about adding the workflow or not? IIRC in nilearn we use the precommit hook but not the github workflow |
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2 ./skrub/_gap_encoder.py ./benchmarks/utils/monitor.py",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
there is outstanding bug in codespell so not all excludes are in effect while running codespell for pre-commit. So we need to list this one explicitly
yarikoptic
force-pushed
the
enh-codespell
branch
from
48119f5
to
0c82b4d
Compare
|
Thanks for triggering actions. I saw that pre-commit did pick up that intentionally added typo, so indeed no separate action is needed. Removed now. Also added explicit exclude for pre-commit of the |
|
We have |
jeromedockes
approved these changes
Nov 29, 2024
jeromedockes
added
CI / build
Vincent-Maladiere
approved these changes
Dec 2, 2024
|
nice! Thanks a lot :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
More about codespell: https://github.com/codespell-project/codespell .
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.
TODO