Add codespell support (config, workflow to detect/not fix) and make it fix few typos #587
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
github-actions
bot
added
documentation
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?
docs/community/code_of_conduct.md
Outdated
| @@ -57,7 +57,7 @@ You can report issues to the napari Code of Conduct committee, at napari-conduct | |||
| * [Nicholas Sofroniew](https://github.com/sofroniewn) | |||
| * [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.
Suggested change
| 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
| @@ -107,4 +107,4 @@ The committee will never publicly discuss the issue; all public statements will | |||
|
|
|||
| ## 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.
Suggested change
| 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
| @@ -276,7 +276,7 @@ function actually instantiating the widget. It accepts only one argument: a | |||
| napari `Viewer` proxy instance. The proxy restricts access to some `Viewer` | |||
| 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.
Suggested change
| 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 ! |
yarikoptic
added a commit
to yarikoptic/codespell
that referenced
this pull request
Feb 20, 2025
Ran into within napari/docs#587
yarikoptic
force-pushed
the
enh-codespell
branch
from
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 ^^^
yarikoptic
force-pushed
the
enh-codespell
branch
from
ac65333 to
2362223
Compare
|
done, pushed, also spotted/ignored one more name. |
yarikoptic
added a commit
to yarikoptic/codespell
that referenced
this pull request
Feb 20, 2025
Ran into within napari/docs#587
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.
Per request at napari/napari#7619 (comment)