Repository navigation
Fix ~219 spelling mistakes across documentation and source code comments #4719
Description
Fix ~219 spelling mistakes across 92 files in documentation (.rst, .md),
source code comments/docstrings, and CI/build scripts.
Identified using codespell v2.4.1 with a custom ignore list for
project-specific terms, followed by manual review to avoid false positives.
Examples of corrections:
| Original | Corrected | Location |
|---|---|---|
compabitility |
compatibility |
README.rst |
environement |
environment |
multiple files |
comparision |
comparison |
docs/ |
maintainence |
maintenance |
CHANGELOG.rst |
dependecy |
dependency |
CHANGELOG.rst |
mispelled |
misspelled |
copyrights.py |
ambigious |
ambiguous |
multiple files |
simultaniously |
simultaneously |
docs/ |
boostrapping |
bootstrapping |
etc/scripts/ |
cheksums |
checksums |
golang.py + test fixtures |
What is NOT changed:
- No code logic, variable names, function names, or class names
- No URLs, file paths, or domain names
- No license rule files (
*.RULE), test data, or third-party code - Intentional non-standard spellings preserved (e.g.,
exmaple.comjunk filter infinder_data.py)
Note: Small overlap with #4712 which also fixes compabitility in README.rst.
Link to Documentation Page
Affects multiple documentation pages including:
- https://scancode-toolkit.readthedocs.io/en/stable/getting-started/contribute/contributing-code.html
- https://scancode-toolkit.readthedocs.io/en/stable/getting-started/contribute/contributing-docs.html
- https://scancode-toolkit.readthedocs.io/en/stable/reference/scancode-cli/cli-basic-options.html
- https://scancode-toolkit.readthedocs.io/en/stable/explanation/scancode-license-detection-updates.html
- And 18+ other documentation pages, plus source code comments in
src/
Select Category
- Inconsistency
- New Section Request
- General Improvement
- Typo/Mistakes
- Other
Signed-off-by: Mrityunjay Raj mr.raj.earth@gmail.com
Activity
Fix spelling mistakes in documentation and source code comments
Siddhazntx commentedon Feb 6, 2026
Hi, I would like to work on this issue.
I will run codespell with the project’s ignore list and manually review all changes to ensure that no code logic, identifiers, URLs, rule files, or test data are modified.
I will also verify overlap with #4712 to avoid duplicate changes.
Please let me know if there are any additional guidelines I should follow before proceeding.
Fix ~85 spelling mistakes across docs and licenses per aboutcode-org#…
kushal-p16 commentedon Mar 20, 2026
Hi,
I am new to the project and would like to contribute to this issue.
I was thinking of starting by fixing a few spelling mistakes (5–10) in documentation files as a first contribution.
Please let me know if this approach works.
Thank you!
Fix spelling mistakes and improve clarity in README.rst
kushal-p16 commentedon Mar 20, 2026
Hi,
I have submitted a PR fixing a few spelling mistakes in README.rst as part of issue #4719.
Please review and let me know if any changes are required.
Thank you!