Skip to content

Tune codespell: move workflow's ignore list into pyproject.toml#270

Open
yarikoptic wants to merge 1 commit into
SpikeInterface:mainfrom
yarikoptic:enh-codespell2
Open

Tune codespell: move workflow's ignore list into pyproject.toml#270
yarikoptic wants to merge 1 commit into
SpikeInterface:mainfrom
yarikoptic:enh-codespell2

Conversation

@yarikoptic
Copy link
Copy Markdown
Contributor

The Codespell CI workflow had ignore_words_list: sortings,trough baked into the YAML, which is only applied in CI. Running codespell locally (or via any other integration) flagged 7 hits for these words that CI silently suppressed — both sortings (plural of Sorting objects) and trough (waveform trough, a real spike-sorting term) are legitimate domain terms, not typos.

Move them into [tool.codespell].ignore-words-list in pyproject.toml so the config is the single source of truth, and add inline comments explaining each entry. Drop the redundant override and the codespell-problem-matcher step from the workflow (problem-matcher annotations are built into actions-codespell@v2).

Verified: uvx codespell exits 0 on the tree.

The Codespell CI workflow had `ignore_words_list: sortings,trough` baked
into the YAML, which is only applied in CI. Running `codespell` locally
(or via any other integration) flagged 7 hits for these words that CI
silently suppressed — both `sortings` (plural of `Sorting` objects) and
`trough` (waveform trough, a real spike-sorting term) are legitimate
domain terms, not typos.

Move them into `[tool.codespell].ignore-words-list` in pyproject.toml so
the config is the single source of truth, and add inline comments
explaining each entry. Drop the redundant override and the
`codespell-problem-matcher` step from the workflow (problem-matcher
annotations are built into `actions-codespell@v2`).

Verified: `uvx codespell` exits 0 on the tree.

Co-Authored-By: Claude Code 2.1.142 / Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant