Repository navigation
CI: Enable codespell for Markdown and HTML files and fix typos - #8029
Merged
Merged
Conversation
Fix spelling mistakes in a DTD file, a LaTeX document, a Python comment, a C++ header comment, a README and the documentation HTML header template. AI assistance (Claude Code) was used to find the typos.
Stop excluding the markdown and html file types from codespell in pre-commit and fix the typos it reports in the tool and general documentation. Add the terms codespell flagged but that are intentional (evapotranspiration ETo, IHS color model, ALOG, a cited author's name and others) to the ignore list. The v.generalize option name betweeness_thresh is a misspelling of betweenness, but it is a user-facing option name, so it is left unchanged here, as renaming it is a larger change. Only the prose around it is corrected. AI assistance (Claude Code) was used to find the typos.
github-actions
Bot
added
windows
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
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.
Typos: some were collected some time ago, and then the search completed to remove the exclusion for html and md files.
Description
Stop excluding
markdownandhtmlfrom the codespell hook in.pre-commit-config.yamland fix the typos it reports (for examplebuild-in,overlayed,co-ordinate,re-use,neigbors,agressive) in the tool and general documentation. Also fix typos in a DTD file, a LaTeX document, a Python comment, a C++ header comment, a README and the documentation HTML header template.Terms codespell flags but that are intentional (ETo, IHS, ALOG, a cited author's name and similar) are added to
ignore-words-listinpyproject.toml.The
v.generalizeoptionbetweeness_threshis a misspelling ofbetweenness. It is a user-facing option name (and an identifier in the C code), so it is deliberately left unchanged because renaming it is a larger change. Only the surrounding prose is corrected.The branch is squashed into two commits: code, comment and template typos, then the codespell configuration with the Markdown and HTML fixes.
Motivation and context
Markdown and HTML files were not spell-checked, so typos had accumulated in the documentation.
How has this been tested?
codespell(v2.4.2) reports nothing for all tracked.mdand.htmlfiles.Types of changes
Checklist
pre-defined prefixes
of this project.
AI assistance (Claude Code) was used to find and fix the typos.