DOC: Spell precommit #5475
Open
DOC: Spell precommit #5475
Conversation
This file contains hidden or 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
type:Infrastructure
dzenanz
reviewed
Jul 23, 2025
Modules/Filtering/BinaryMathematicalMorphology/test/itkBinaryDilateImageFilterTest.cxx
Outdated
Show resolved
Hide resolved
...mentation/ConnectedComponents/test/itkThresholdMaximumConnectedComponentsImageFilterTest.cxx
Show resolved
Hide resolved
github-actions
bot
added
the
area:Documentation
dzenanz
approved these changes
Jul 24, 2025
dzenanz
approved these changes
Jul 24, 2025
Now that the spell checker is being run on all the CXX files in ITK, we need to fix some of the spell bugs that existed.
This PR address a spell checking pre-commit to ITK. So any time code is committed to an ITK repo, the SimpleITK/CommentSpellCheck (CSC) script is run on the new code. CSC checks the spelling of all comments in new file. Also the version of CSC use is upgraded to 0.4.3, which uses a pure Python spelling backend, unlike the previous version. That previous version depended on the C enchant library, which was not available on all systems. We have removed the spell checking github action, since it is no longer required. Any time a pull request is submitted to github, pre-commit is run.
|
I think it's ready to go. |
dzenanz
reviewed
Jul 29, 2025
| Cz | ||
| DDataFrameobject | ||
| Daniesson |
| @@ -64,45 +76,61 @@ Elmaghraby | |||
| Englewood | |||
| Eun | |||
| Evol | |||
| ExhaustiveOptv | |||
There was a problem hiding this comment.
Why not rename this, like many other things? It appears in a test, and is therefore not part of the public API.
There was a problem hiding this comment.
Should I exclude all tests from the spell checking?
There was a problem hiding this comment.
That would only make sense as a temporary measure. This PR is already big. You could disable spell check in tests, and add an issue to enable it. Then tackle it when you (or someone else) has enthusiasm and time to spare.
| Hideaki | ||
| Hierarchique | ||
| Hilden | ||
| Hiraki | ||
| Hirschberg | ||
| Hmmm |
There was a problem hiding this comment.
This is not a necessary part of a comment here, and could be removed instead of added to the dictionary.
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.
PR Checklist
Refer to the ITK Software Guide for
further development details if necessary.
This PR address a spell checking pre-commit to ITK. So any time code is committed to an ITK repo, the SimpleITK/CommentSpellCheck (CSC) script is run on the new code. CSC checks the spelling of all comments in new file.
Previously CSC was run on ITK as a Github Action on the ITK repository. Moving to a pre-commit runs CSC on the local developer's system allowing for faster feedback and reducing Github server usage. Therefore, this PR removes .github/workflows/spell-check-comments.yml.
Also this PR includes many spelling fixes to the C++ files in the ITK code base. These bugs had not been address before because our main concern has been the spelling in the header files, which are used to create the documentation. With this new PR, the .cxx are also checked, so we had to fixed all the bugs already in ITK.
The .cxx fixes are split into multiple commits for organizational sake. All the commits in this PR can be squashed into one, if that is preferred.
UPDATE: I also meant to say that the version of CSC has been upgraded to the latest 0.4.3. This version uses a pure Python spelling backend, unlike the previous version. That previous version depended on the C enchant library, which was not available on all systems.