Add codespell config, CI workflow, and fix existing typos - #26
Open
yarikoptic wants to merge 5 commits into
Open
Add codespell config, CI workflow, and fix existing typos#26yarikoptic wants to merge 5 commits into
yarikoptic wants to merge 5 commits into
Conversation
Config changes: - Add .git-meta to skip list (per-repo working folder for commit/PR drafts; commonly quotes the very typos being fixed). - Whitelist "shure" (Shure is a microphone brand, e.g. "Shure SM7B"). Ambiguous typo fix (single suggestion tie: this/these): - docs/user-guide/dandi-cli.md:3 "In thes instructions" -> "these" (refers to the multi-step instructions that follow). Co-Authored-By: Claude Code 2.1.247 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fixed typos:
- Contibutions -> Contributions (README.md)
- Verfication -> Verification (docs/example-standardization-and-reproducibility/Suthana_Zenodo.md)
- acounts -> accounts (docs/getting-started/index.md)
- instituion -> institution (docs/user-guide/embervault-uploading-data.md)
Co-Authored-By: Claude Code 2.1.247 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
=== Do not change lines below ===
{
"chain": [],
"cmd": "uvx codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Spotted while reviewing surrounding context of codespell fixes; codespell's default dictionaries do not carry either mapping: - docs/getting-started/index.md:17 "accounr" -> "account" - docs/getting-started/index.md:20 "approal" -> "approval" Co-Authored-By: Claude Code 2.1.247 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Add codespell configuration, a GitHub Actions workflow that runs it on PRs / pushes to
main, and fix the typos it (and I) found in the docs.I've introduced codespell to many open-source projects with positive feedback (see improveit-dashboard/READMEs/yarikoptic.md for context). The CI workflow uses
permissions: contents: readonly.Changes at a glance
pyproject.toml[tool.codespell]): skip.git-meta, binaries and lock files; whitelistshure(microphone brand, "Shure SM7B")..github/workflows/codespell.yml): runs on push / PRs tomain, read-only permissions.Testing
codespellpasses with zero errors on the branch (verified locally withuvx codespelland via the new workflow).Typo fixes (7)
Non-ambiguous, fixed via
codespell -w(recorded reproducibly withdatalad run):README.md:29ContibutionsContributionsdocs/example-standardization-and-reproducibility/Suthana_Zenodo.md:36(heading)VerficationVerificationdocs/getting-started/index.md:18acountsaccountsdocs/user-guide/embervault-uploading-data.md:17instituioninstitutionAmbiguous (single suggestion tie:
this/these), decided from context:docs/user-guide/dandi-cli.md:3Spotted while reviewing surrounding context (not in codespell's default dictionaries):
docs/getting-started/index.md:17accounraccountdocs/getting-started/index.md:20approalapprovalConfig choices
.git-metain skip: a per-repo working folder for commit / PR message drafts (git-excluded, never committed). Codespell walks the filesystem, so it would otherwise re-flag the very typos being fixed inside quoted commit messages.shurein ignore-words-list: appears indocs/user-guide/data-standardization.mdas"Microphone": "Shure SM7B"— Shure is a legitimate microphone brand, not a typo of "sure".--builtin clear,rare,usage,code,names) surfaces onlyJupyter → Jupiter, a false positive (Jupyter notebook is intentional). No further whitelist entries needed because the default CI pass is clean.🤖 Generated with Claude Code and love to typos-free code