Fix ~219 spelling mistakes in documentation and source code comments#4720
Open
mr-raj12 wants to merge 2 commits intoaboutcode-org:developfrom
Open
Fix ~219 spelling mistakes in documentation and source code comments#4720mr-raj12 wants to merge 2 commits intoaboutcode-org:developfrom
mr-raj12 wants to merge 2 commits intoaboutcode-org:developfrom
Conversation
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]>
Member
Thanks for this, can this be automated and added to the CI in some way? |
Author
|
Yes, we can integrate codespell in CI. |
2 tasks
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]>
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.
Fixes #4719
Summary
source code comments/docstrings, CI scripts, and corresponding test fixtures
Examples
compabitilitycompatibilityenvironementenvironmentmaintainencemaintenancecomparisioncomparisonmispelledmisspelledboostrappingbootstrappingcheksumschecksumsambigiousambiguousIntentionally preserved
exmaple.cominfinder_data.py(junk filter data, not a typo)Test fixtures updated
tests/packagedcode/data/plugin/help.txttests/packagedcode/data/plugin/plugins_list_linux.txttests/summarycode/data/todo/todo_present/README.multi-orig-tarball-package-expected-diag.jsonNote: Small overlap with #4712 on
compabitilityin README.rst.Signed-off-by: Mrityunjay Raj [email protected]