Skip to content

Fix ~219 spelling mistakes in documentation and source code comments#4720

Open
mr-raj12 wants to merge 2 commits intoaboutcode-org:developfrom
mr-raj12:fix/spelling-corrections-docs-and-comments
Open

Fix ~219 spelling mistakes in documentation and source code comments#4720
mr-raj12 wants to merge 2 commits intoaboutcode-org:developfrom
mr-raj12:fix/spelling-corrections-docs-and-comments

Conversation

@mr-raj12
Copy link

@mr-raj12 mr-raj12 commented Feb 2, 2026

Fixes #4719

Summary

  • Fix ~219 spelling errors across 93 files in documentation (.rst, .md),
    source code comments/docstrings, CI scripts, and corresponding test fixtures
  • No code logic changes — only human-readable text
  • Identified using codespell v2.4.1 with project-specific ignore list, followed by manual review

Examples

Original Corrected
compabitility compatibility
environement environment
maintainence maintenance
comparision comparison
mispelled misspelled
boostrapping bootstrapping
cheksums checksums
ambigious ambiguous

Intentionally preserved

  • exmaple.com in finder_data.py (junk filter data, not a typo)
  • All variable names, function names, URLs, file paths, regex patterns
  • All license rule files, test data, third-party code

Test fixtures updated

  • tests/packagedcode/data/plugin/help.txt
  • tests/packagedcode/data/plugin/plugins_list_linux.txt
  • tests/summarycode/data/todo/todo_present/README.multi-orig-tarball-package-expected-diag.json

Note: Small overlap with #4712 on compabitility in README.rst.

Signed-off-by: Mrityunjay Raj [email protected]


Fix ~219 spelling errors across 92 files including documentation (.rst, .md),
source code comments/docstrings, and corresponding test fixtures.

Key corrections: compatibility, maintenance, dependency, environment,
comparison, simultaneously, unnecessary, bootstrapping, and many others.

No code logic changes - only human-readable text in comments, docstrings,
and documentation. Test fixtures updated where source string changes
affect serialized output.

Identified using codespell with project-specific ignore list.

Fixes aboutcode-org#4719

Signed-off-by: Mrityunjay Raj <[email protected]>
@AyanSinhaMahapatra
Copy link
Member

Identified using codespell v2.4.1 with project-specific ignore list, followed by manual review

Thanks for this, can this be automated and added to the CI in some way?

@mr-raj12
Copy link
Author

mr-raj12 commented Feb 3, 2026

Yes, we can integrate codespell in CI.
We can add a lightweight GitHub Actions workflow for this. I can raise an issue and take it up, let me know whether you’d prefer it to run on every PR or as a scheduled (maybe weekly) check, and you can assign it to me.

Extend the section underline to match the corrected title length after
the spelling fix (Documentaion -> Documentation). Sphinx requires the
underline to be at least as long as the title text.

Signed-off-by: Mrityunjay Raj <[email protected]>
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.

Fix ~219 spelling mistakes across documentation and source code comments

2 participants