Add codespell support (config, workflow to detect/not fix) and make it fix few typos #26315
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
|
Please don't touch the changelogs, they match the title used in the corresponding PR, typos and all. |
ngoldbaum
reviewed
Apr 19, 2024
| @@ -262,7 +262,7 @@ conflict of interests include, but are not limited to: | |||
| All members of the Council shall disclose to the rest of the Council any | |||
| conflict of interest they may have. Members with a conflict of interest | |||
| in a particular issue may participate in Council discussions on that | |||
| issue, but must recuse themselves from voting on the issue. | |||
| issue, but must recurse themselves from voting on the issue. | |||
There was a problem hiding this comment.
not a big fan of a adding automated spell-checking if we'll have to ignore it making mistakes like this...
There was a problem hiding this comment.
rright -- I even ran into this particular one before -- recuse is indeed rare and I failed to spot it in review, sorry about that. I will whitelist it.
Used codespellit list-hits-sorted | sed -n -e '/6 /,9999p' | tac | f2 | tr '\n' ',' to find and sort
…espell + parms -> params
… fp{k}
I think it makes them more consistent (always a suffix) and also more
readable since more descriptive of the taken action.
This is triggered to avoid "looks-like-a-typo" hits in codespell for fpr and likely
others
yarikoptic
force-pushed
the
enh-codespell
branch
from
14d5762
to
66941b7
Compare
|
Thanks for quick feedback @charris and @ngoldbaum ! I
|
yarikoptic
commented
Apr 19, 2024
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
… automagically but ignoring the failure due to ambigous typos
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w || :",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
…us typos
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"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 ^^^
Funny thing is that it does not catch it on 'main' for some reason but catches here... it is likely because python tools/linter.py --branch origin/main works on the diff only (too fast on main) and thus whenever those spaces were introduced, it did not check and never flipped since then. I changed that line, and it was checked and flagged.
yarikoptic
force-pushed
the
enh-codespell
branch
from
66941b7
to
bb7d7f3
Compare
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.
There were numerous commits where
codespellwas used "manually" to fixup some of the typos.CI: use codespell, flake8 to check code before merging? #13694 still contemplates idea of running
codespellon PRsAn early attempt to introduce codespell CI was abandoned: BLD: Codespell for NumPy CI #19594 -- IMHO now is better time!
I did
lapack_litelast in the separate commits if there is desire to not touch it (although I saw commits fixing typos in it as well).I did some variable renames to take them away from "close to a typo" form, might be worth having a look and suggesting alternative names.
I did fix older changelogs as I think there is no point to cherish typos in them, but they could also be ignored.