Skip to content

CI: Enable codespell for Markdown and HTML files and fix typos - #684

Closed
echoix wants to merge 4 commits into
mainfrom
claude/typo-fixes-g3h3w1
Closed

echoix wants to merge 4 commits into
mainfrom
claude/typo-fixes-g3h3w1

Conversation

@echoix

@echoix echoix commented Sep 4, 2026 •

Copy link
Copy Markdown
Owner

Description

Stop excluding markdown and html from the codespell hook in .pre-commit-config.yaml and fix the typos it reports (for example build-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-list in pyproject.toml.

The v.generalize option betweeness_thresh is a misspelling of betweenness. 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 .md and .html files.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • PR title provides summary of the changes and starts with one of the
    pre-defined prefixes
  • My code follows the code style
    of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.

AI assistance (Claude Code) was used to find and fix the typos.

Comment thread ps/ps.map/README Outdated
Comment thread pyproject.toml Outdated
Comment thread pyproject.toml Outdated
Comment thread .pre-commit-config.yaml Outdated
@echoix
echoix force-pushed the claude/typo-fixes-g3h3w1 branch 2 times, most recently from 185cc55 to aa723d4 Compare September 4, 2026 12:32
@echoix echoix changed the title Fix typos and configure codespell Fix typos across multiple file types Sep 4, 2026
@echoix
echoix force-pushed the claude/typo-fixes-g3h3w1 branch from 9ac0ebf to 1bf1461 Compare September 4, 2026 12:44
Comment thread vector/v.generalize/v.generalize.html Outdated
Comment thread vector/v.generalize/v.generalize.html Outdated
Comment thread vector/v.generalize/v.generalize.md Outdated
Comment thread vector/v.generalize/v.generalize.md Outdated
echoix added 2 commits October 4, 2026 18:03
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.
@echoix
echoix force-pushed the claude/typo-fixes-g3h3w1 branch from 0731504 to f16ff5c Compare October 4, 2026 18:03
@echoix echoix changed the title Fix typos across multiple file types CI: Enable codespell for Markdown and HTML files and fix typos Oct 4, 2026
@echoix echoix closed this Oct 9, 2026
@echoix
echoix deleted the claude/typo-fixes-g3h3w1 branch October 9, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant