Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mr-raj12 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23df384
Fix spelling mistakes in documentation and source code comments
mr-raj12 Feb 2, 2026
247a94e
Fix RST title underline length in contributing-docs.rst
mr-raj12 Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/--feature-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

<!-- Please fill out as much of the template as you can. Delete sections if unneccesary -->
<!-- Please fill out as much of the template as you can. Delete sections if unnecessary -->
<!--
Make Sure you've checked out
Existing Issues,
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- Delete Template sections if unneccesary -->
<!-- Delete Template sections if unnecessary -->
<!-- Add issue number here (We encourage you to create the Issue First) -->
<!-- You can also link the issue in Commit Messages -->

Expand Down
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ The following organizations or individuals have contributed to ScanCode:
- Michael Rupprecht @michaelrup
- Mike Rombout @mrombout
- Mrinal Paliwal @mnpw
- Mrityunjay Raj @mr-raj12
- nexB Inc. @nexB
- Nirmal Sarswat @vivonk
- Nisha Kumar @nishakm
Expand Down
40 changes: 20 additions & 20 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ This is a patch release with bugfixes and improvements::
improvements by removing unnecessary regex substitutions.
https://github.com/aboutcode-org/scancode-toolkit/issues/4063

- Fix misc scancode doumentation related issues
- Fix misc scancode documentation related issues
https://github.com/aboutcode-org/scancode-toolkit/pull/4457
https://github.com/aboutcode-org/scancode-toolkit/pull/4458
https://github.com/aboutcode-org/scancode-toolkit/pull/4462
Expand Down Expand Up @@ -127,7 +127,7 @@ from ``4.0.0`` to ``4.1.0``. The changes in Output Data Structure are:
directories. This is returned optionally with the ``--info`` plugin.

- A new resource level attribute ``is_community`` is added, which is
True from commonly used files used for community/project maintainence.
True from commonly used files used for community/project maintenance.
This is returned optionally with the ``--classify`` plugin.

These are the details for the most important changes introduced::
Expand Down Expand Up @@ -340,7 +340,7 @@ v32.2.1 - 2024-07-02
- Add support for poetry packages, with poetry specific pyproject.toml
support, poetry.lock and package assembly support. Also add support
for parsing and storing resolved packages and dependency relationships
required to statically resolve poetry dependecy graphs.
required to statically resolve poetry dependency graphs.
See https://github.com/nexB/scancode-toolkit/issues/2109

- Add support for pyproject.toml files in python projects.
Expand Down Expand Up @@ -378,7 +378,7 @@ v32.2.0 - 2024-06-19
- Fix a bug in dependency parsing (we were not returning any dependencies)
- Also support getting dependency versions from workspace
- Support more attributes from cargo
- Better handle workspace data thorugh extra_data attribute
- Better handle workspace data through extra_data attribute
See https://github.com/nexB/scancode-toolkit/pull/3783

- We now support parsing the Swift manifest JSON dump and the
Expand Down Expand Up @@ -455,7 +455,7 @@ Changes in Output Data Structure:
- in package ``license_detections`` and ``other_license_detections``
- ``matches`` for ``license_detections`` everywhere

- Adds all rule atrribute level info in codebase level ``todo``
- Adds all rule attribute level info in codebase level ``todo``
data, to assist in review. This includes length, text, notes,
referenced_filenames, and the boolean attributes (like
is_license_notice, is_license_intro etc, as applicable).
Expand Down Expand Up @@ -815,7 +815,7 @@ License detection:
license ``key`` of a matched license expression. We now report instead one
single match for each matched license expression, and list the license keys
as a ``licenses`` attribute. This avoids data duplication.
Inside each match, we list each match and matched rule attributred directly
Inside each match, we list each match and matched rule attributed directly
avoiding nesting. See `license updates doc <https://scancode-toolkit.readthedocs.io/en/latest/reference/license-detection-reference.html#licensematch-result-data>`_
for examples and details.

Expand All @@ -841,7 +841,7 @@ License detection:
- There is an ``--additional-directory`` option with the ``scancode-reindex-licenses``
command to add the licenses from a directory.

- There is also a ``--only-builtin`` option to use ony builtin licenses
- There is also a ``--only-builtin`` option to use only builtin licenses
ignoring any additional license plugins.

- See https://github.com/nexB/scancode-toolkit/issues/480 for more details.
Expand Down Expand Up @@ -887,7 +887,7 @@ v31.2.6 - 2023-04-25

This is a minor hotfix release.

This fix a crash when parsing a .deb Dbeian package filename
This fix a crash when parsing a .deb Debian package filename
reported in https://github.com/nexB/scancode-toolkit/issues/3259


Expand Down Expand Up @@ -1005,7 +1005,7 @@ Important API changes:
instances that can be aggregating data from multiple manifests.

- There is a a new top-level "dependencies" attribute that contains each
dependency instance, these can be standalone or releated to a package.
dependency instance, these can be standalone or related to a package.
These contain a new "extra_data" object.

- There is a new resource-level attribute "for_packages" which refers to
Expand Down Expand Up @@ -1035,9 +1035,9 @@ Important API changes:
- ``DatafileHandler.assemble()``, ``DatafileHandler.assemble_from_many()``, and
the other ``.assemble()`` methods from the other Package handlers from
packagedcode, have been updated to yield Package items before Dependency or
Resource items. This is particulary important in the case where we are calling
Resource items. This is particularly important in the case where we are calling
the ``assemble()`` method outside of the scancode-toolkit context, where we
need to ensure that a Package exists before we assocate a Resource or
need to ensure that a Package exists before we associate a Resource or
Dependency to it.

Copyright detection:
Expand Down Expand Up @@ -1373,7 +1373,7 @@ v30.0.0 - 2021-09-23
This is a major release with new features, and several bug fixes and
improvements including major updates to the license detection.

We have droped using calendar-based versions and are now switched back to semver
We have dropped using calendar-based versions and are now switched back to semver
versioning. To ensure that there is no ambiguity, the new major version has been
updated from 21 to 30. The primary reason is that calver was not helping
integrators to track major version changes like semver does.
Expand Down Expand Up @@ -1940,7 +1940,7 @@ v3.2.0rc1 (2020-09-08)
- Improve license detection #1999 - Bryan Sutula
- Correct CC0 license #1984 - Carmen Bianca Bakker
- Add documentation for the usage of `cpp_includes` plugin - Chin Yeung Li
- Improve andling of npm package-lock.json #1993 - Chin Yeung Li
- Improve handling of npm package-lock.json #1993 - Chin Yeung Li
- Add new license detection rules - Gaupeng
- Improve documentation - Issei Horie
- Improve consolidation plugin - Jono Yang @JonoYang
Expand Down Expand Up @@ -2027,7 +2027,7 @@ Other features and fixes:
v3.1.0 (2019-08-12)
-------------------

- Add partial suport for Python 3.6+ #295 @Abhishek-Dev09
- Add partial support for Python 3.6+ #295 @Abhishek-Dev09
- Add plugin to collect dwarf references #1167 @licodeli
- Add fingerprint plugin #1651 @arnav-mandal1234
- Add summary and consolidation plugin #1673
Expand Down Expand Up @@ -2208,8 +2208,8 @@ v2.9.6 (2018-10-25)

- Add declared license normalization #1092
- Add new and improved license rules
- Add mising and clean up ABOUT files for all embedded third-party libraries
- Improve npm package.json handling (better keuword support)
- Add missing and clean up ABOUT files for all embedded third-party libraries
- Improve npm package.json handling (better keyword support)
- Update thirdparty libraries #1224

Credits: Many thanks to everyone that contributed to this release with code and bug reports
Expand Down Expand Up @@ -2288,7 +2288,7 @@ Misc:
- Add facet, classification and summarizer plugins #357
- Fix file counts #1055
- Fix corrupted license cache error
- Upgrade all thridparty libraries #1070
- Upgrade all third party libraries #1070
- De-vendor prebuilt binaries to ease packaging for Linux distros #469

Credits: Many thanks to everyone that contributed to this release with code and bug reports
Expand Down Expand Up @@ -2429,8 +2429,8 @@ Licenses:
words compared to the number of words in the matched rule.
- The license cache is not checked anymore for consistency once created which
improved startup times. (unless you are using a Git checkout and you are
developping with a SCANCODE_DEV_MODE tag file present)
- License catagory names have been improved
developing with a SCANCODE_DEV_MODE tag file present)
- License category names have been improved

Copyrights:
- Copyright detection in binary files has been improved
Expand All @@ -2453,7 +2453,7 @@ Misc:
- Move essential configuration to a scancode_config.py module
- Only read a few pages from PDF files by default
- Improve handling of files with weird characters in their names on all OSses
- Improve detection of archive vs. comrpessed files
- Improve detection of archive vs. compressed files
- Make all copyright tests data driven using YAML files like for license tests


Expand Down
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Build and tests status
======================

We run 30,000+ tests on each commit on multiple CIs to ensure a good platform
compabitility with multiple versions of Windows, Linux and macOS.
compatibility with multiple versions of Windows, Linux and macOS.

+------------+--------------+-------------------------+----------------------------+
| **Azure** | **RTD Build**| **GitHub actions Docs** | **GitHub actions Release** |
Expand Down Expand Up @@ -64,7 +64,7 @@ Benefits of ScanCode

- ScanCode detects licenses, copyrights, package manifests, direct dependencies,
and more both in **source code** and **binary** files and is considered as the
best-in-class and reference tool in this domain, re-used as the core tools for
best-in-class and reference tool in this domain, reused as the core tools for
software composition data collection by several open source tools.

- ScanCode provides the **most accurate license detection engine** and does a
Expand Down Expand Up @@ -92,7 +92,7 @@ If you have a specific problem, suggestion or bug, please submit a

For quick questions or socializing, join the AboutCode community discussions on `Slack <https://join.slack.com/t/aboutcode-org/shared_invite/zt-3li3bfs78-mmtKG0Qhv~G2dSlNCZW2pA>`_.

Interested in commercial suppport? Contact the `AboutCode team <mailto:hello@aboutcode.org>`_.
Interested in commercial support? Contact the `AboutCode team <mailto:hello@aboutcode.org>`_.

License
=======
Expand Down
6 changes: 3 additions & 3 deletions ROADMAP-ABOUTCODE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ License detection quality improvements
Improve package detection
~~~~~~~~~~~~~~~~~~~~~~~~~~

- Create synthethic, private packages from non-packaged files based on license and copyright
- Create synthetic, private packages from non-packaged files based on license and copyright
- Create simplified purl-only lightweight package detection
- Evolve model for dependencies towards requirements and true dependencies
- Track private non-published packages
Expand Down Expand Up @@ -142,7 +142,7 @@ PURLDB: PurlDB
- MatchCode matching engine

- embed a SCIO with a matching pipeline for match a whole codebase at once
- expore new endpoint for matching whole codebase
- explore new endpoint for matching whole codebase
- support multiple SCIO workers for indexing
- implement proper ranking of matched code results
- refactor directory matching to be a pre-matching step to file matching
Expand All @@ -162,7 +162,7 @@ VCIO: VulnerableCode.io
PURL: purl and vers specs
--------------------------

- Merge and advertize vers spec.
- Merge and advertise vers spec.
- Standardize purl with ECMA


Expand Down
6 changes: 3 additions & 3 deletions docs/source/explanation/scancode-license-detection-updates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ report here). We are now just reporting a flat mapping here, and all the
rule details are also not present in the license match, and only available
as an optional reference.

See this before/after comparision to see how the license data in results has
See this before/after comparison to see how the license data in results has
evolved.

Before::
Expand Down Expand Up @@ -536,12 +536,12 @@ This is now default with the CLI option ``--license``, which references from
the match License-level Data and LicenseDB-level Data, and removes the actual data from
the matches, and adds them to two top-level lists.

Comparision: Before/After license references
Comparison: Before/After license references
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To compare how the license output data changes between when license references are not collected
vs when they are collected (which is default from version 32.x), check out the before/after
comparision below.
comparison below.

Before::

Expand Down
12 changes: 6 additions & 6 deletions docs/source/getting-started/contribute/contributing-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ TL;DR:
- Contributions comes as bugs/questions/issues and as pull requests.
- Source code and runtime data are in the /src/ directory.
- Test code and test data are in the /tests/ directory.
- Datasets (inluding licenses) and test data are in /data/ sub-directories.
- Datasets (including licenses) and test data are in /data/ sub-directories.
- We use DCO signoff in commit messages, like Linux does.
- Porting ScanCode to other OS (FreeBSD is supported, etc.) is possible. Enter an issue for help.

Expand Down Expand Up @@ -62,7 +62,7 @@ Running tests
-------------

ScanCode comes with over 29,000 unit tests to ensure detection accuracy and
stability across Linux, Windows and macOS OSes: we kinda love tests, do we?
stability across Linux, Windows and macOS OSes: we kind of love tests, do we?

We use pytest to run the tests: call the ``pytest`` script to run the whole
test suite. This is installed with the ``pytest`` package which is installed
Expand Down Expand Up @@ -99,7 +99,7 @@ Another useful option after a test run with some failures is to re-run only the
failed tests with the ``--lf`` option, for instance: ``pytest -vvs --lf`` would
only run only test functions that failed in the previous run.

Because we have a lot of tests (over 29,000), we organized theses in test suites
Because we have a lot of tests (over 29,000), we organized these in test suites
using pytest markers that are defined in the ``conftest.py`` pytest plugin.
These are enabled by adding a ``--test-suite`` option to the pytest command.

Expand All @@ -109,8 +109,8 @@ These are enabled by adding a ``--test-suite`` option to the pytest command.
extensive data-driven and data validations (for package, copyright and license
detection)

In some cases we need to regenerate test data when expected behavious/result data
structures change, and we have an environement variable to regenerate test data.
In some cases we need to regenerate test data when expected behaviour/result data
structures change, and we have an environment variable to regenerate test data.
`SCANCODE_REGEN_TEST_FIXTURES` is present in `scancode_config` and this can be
set to regenerate test data for specific tests like this:

Expand All @@ -124,7 +124,7 @@ If test data is regenerated, it is important to review the diff for test files a
carefully go through all of it to make sure there are no unintended changes there,
and then commit all the regenerated test data.

To help debug in scancode, we use logging. There are different environement variables
To help debug in scancode, we use logging. There are different environment variables
you need to set to turn on logging. In packagedcode::

``SCANCODE_DEBUG_PACKAGE=yes pytest -vvs tests/packagedcode/ --lf``
Expand Down
8 changes: 4 additions & 4 deletions docs/source/getting-started/contribute/contributing-docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ AboutCode documentation uses
`Intersphinx <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects.

To link sections in the same documentation, standart reST labels are used. Refer
To link sections in the same documentation, standard reST labels are used. Refer
`Cross-Referencing <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`_
for more information.

Expand All @@ -143,7 +143,7 @@ For example::

It refers to the section itself, see :ref:`my-reference-label`.

Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then referance
Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then reference
these labels from another Sphinx Documentation, hosted in different locations.

You just have to add the following in the ``conf.py`` file for your Sphinx Documentation, where you
Expand Down Expand Up @@ -183,8 +183,8 @@ For more information, refer this tutorial named

.. _contributing-docs-style-conventions:

Style Conventions for the Documentaion
--------------------------------------
Style Conventions for the Documentation
----------------------------------------

1. Headings

Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting-started/contribute/roadmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Core features
^^^^^^^^^^^^^

- |white_check_mark| pre scan filtering (ignore binaries, etc)
- |white_check_mark| pre/post/ouput plugins! (worked as part of the GSoC by @yadsharaf )
- |white_check_mark| pre/post/output plugins! (worked as part of the GSoC by @yadsharaf )
- |white_check_mark| scan plugins (e.g. plugins that run a scan to collect data)
- |white_check_mark| support Python 3 #295
- |clock1030| transparent archive extraction (as opposed to on-demand with extractcode)
Expand Down Expand Up @@ -110,7 +110,7 @@ Packaging

- |white_large_square| simpler installation, automated installer
- |white_check_mark| distro-friendly packaging
- |clock1030| unbundle and package as multiple libaries (commoncode, extractcode, etc)
- |clock1030| unbundle and package as multiple libraries (commoncode, extractcode, etc)

Documentation
^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/installation/install-scancode-from-source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ it is recommended to run the help command.

For use in development, run instead ``configure --dev``. If your encounter
issues while configuring a previous version, use ``configure --clean`` to
clean and reset your enviroment. After that, run ``configure`` again.
clean and reset your environment. After that, run ``configure`` again.
2 changes: 1 addition & 1 deletion docs/source/how-to-guides/how-to-add-new-license-detection-rule.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ and other options.

.. note::

Add rules in a local developement installation and run `scancode-reindex-licenses`
Add rules in a local development installation and run `scancode-reindex-licenses`
to make sure we reindex the rules and this validates the new licenses.
2 changes: 1 addition & 1 deletion docs/source/how-to-guides/how-to-generate-attribution-docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ How to generate attribution doc from a ScanCode scan
====================================================

Users can use an Open Source Project "AboutCode Toolkit" to generate
attrbution document from a ScanCode scan.
attribution document from a ScanCode scan.

Read more about AboutCode Toolkit here: https://aboutcode-toolkit.readthedocs.io/.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/how-to-guides/how-to-install-new-license-plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _how-to-install-new-license-plugin:

How to install external licenses to use in license dectection
How to install external licenses to use in license detection
=============================================================

Users can install external licenses and rules in the form of:
Expand Down
Loading
Loading