Add codespell support (config, workflow to detect/not fix) and make it fix few typos#587
Conversation
psobolewskiPhD
left a comment
There was a problem hiding this comment.
Caught a few false positives.
How will those work going forward? will they get re-flagged?
General question: what do we want to do about release notes? There are typos there, but those are the titles of the PRs, which are the source of truth?
Should we skip the release notes? or fix them? fix the PR titles?
| * [Kira Evans](https://github.com/kne42) | ||
|
|
||
| If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recuse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact: | ||
| If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recurse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact: |
There was a problem hiding this comment.
| If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recurse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact: | |
| If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recuse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact: |
Revert please https://www.merriam-webster.com/dictionary/recuse
| ## Conflicts of interest | ||
|
|
||
| In the event of any conflict of interest, a committee member must immediately notify the other members, and recuse themselves if necessary. | ||
| In the event of any conflict of interest, a committee member must immediately notify the other members, and recurse themselves if necessary. |
There was a problem hiding this comment.
| In the event of any conflict of interest, a committee member must immediately notify the other members, and recurse themselves if necessary. | |
| In the event of any conflict of interest, a committee member must immediately notify the other members, and recuse themselves if necessary. |
Revert please https://www.merriam-webster.com/dictionary/recuse
| functionality like private methods. | ||
|
|
||
| Similarly `napari_experimental_provide_function` hooks return ane or more | ||
| Similarly `napari_experimental_provide_function` hooks return and or more |
There was a problem hiding this comment.
| Similarly `napari_experimental_provide_function` hooks return and or more | |
| Similarly `napari_experimental_provide_function` hooks return one or more |
It is a typo, but not the right fix 🤣
There was a problem hiding this comment.
a few ways to ignore them -(I already ignored some) - either via config (added in this PR) or "inline" (less applicable in docs) . See https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file . Let me address those false positives now, good eye @psobolewskiPhD ! |
Ran into within napari/docs#587
83418e2 to
ac65333
Compare
=== 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 -i 3 -C 2 ./docs/release/release_0_5_0.md",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
…agically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
ac65333 to
2362223
Compare
|
done, pushed, also spotted/ignored one more name. |
Ran into within napari/docs#587
|
I asked this on the napari/napari PR, but i think it's good to have the info here too. |
Ran into within napari/docs#587
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.
Per request at napari/napari#7619 (comment)