Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Spelling corrections #224

Conversation

albert-github
Copy link
Contributor

Spelling corrections

Spelling corrections
@github-actions github-actions bot added area:Introduction Issues affecting the Introduction part area:DevelopmentGuidelines Issues affecting the Development Guidelines part area:Examples Issues affecting the ITK Examples scraper area:DesignAndFunctionality Issues affecting the Design And Functionality part area:Appendices Issues affecting the Appendices part language:LaTeX Changes to LaTeX code type:Artwork Changes to artwork files type:BookStyle Changes to book style files type:Infrastructure type:Documentation Documentation improvement or change labels Mar 22, 2025
Copy link
Member

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this @albert-github.

What tool did you use for this? @dzenanz we should probably add some tool to the GHAs to do this.

A few inline comments.

review: Spelling corrections
@albert-github
Copy link
Contributor Author

What tool did you use for this? @dzenanz we should probably add some tool to the GHAs to do this.

It is a very simple spelling checker, https://github.com/codespell-project/codespell.git, and it gives a list of possible mistakes. It also gives, in code parts, quite a few false positives so one has to work through these by hand. I don't think the tool is suitable for GHA as it will give quite a few false positives.
Probably there are better tools around.

Copy link
Member

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few inline comments.

review: Spelling corrections
review: Spelling corrections
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@albert-github thank you!

@thewtex thewtex merged commit ee9da15 into InsightSoftwareConsortium:main Mar 24, 2025
3 checks passed
@albert-github albert-github deleted the feature/bug_spell_20250322 branch March 25, 2025 08:33
@jhlegarreta
Copy link
Member

@albert-github thanks for doing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Appendices Issues affecting the Appendices part area:DesignAndFunctionality Issues affecting the Design And Functionality part area:DevelopmentGuidelines Issues affecting the Development Guidelines part area:Examples Issues affecting the ITK Examples scraper area:Introduction Issues affecting the Introduction part language:LaTeX Changes to LaTeX code type:Artwork Changes to artwork files type:BookStyle Changes to book style files type:Documentation Documentation improvement or change type:Infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants