🔧 Add codespell

* Add pre-commit check * Fix spelling
cusyio · Sep 23, 2024 · 8aff5c9 · 8aff5c9
1 parent 95b6600
commit 8aff5c9
Show file tree

Hide file tree

Showing 39 changed files with 68 additions and 59 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -38,3 +38,8 @@ repos:
     - id: sphinx-lint
       args: [--jobs=1]
       types: [rst]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+    - id: codespell
+      args: [--toml pyproject.toml]
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -34,7 +34,7 @@ The versions follow `Semantic Versioning <https://semver.org/lang/de/>`_:
 
 24.1.0
 
-* 📝 Update redis licenses, add hint to Redict and Valkey
+* 📝 Update redis licenses, add hint to Redirect and Valkey
 
 * Git
 

diff --git a/docs/clean-prep/string-matching.ipynb b/docs/clean-prep/string-matching.ipynb
@@ -40,7 +40,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 2. Imort"
+    "## 2. Import"
    ]
   },
   {

diff --git a/docs/data-processing/apis/grpc/index.rst b/docs/data-processing/apis/grpc/index.rst
@@ -114,7 +114,7 @@ specifies the communication between clients and servers:
 #. First the stream is started by the client with a mandatory ``Call Header``
 
    #. followed by optional ``Initial-Metadata``
-   #. followd by optional ``Payload Messages``.
+   #. followed by optional ``Payload Messages``.
 
    The contents of ``Call Header`` and ``Initial Metadata`` are sent as HTTP/2
    headers compressed with ``HPACK``.

diff --git a/docs/data-processing/apis/index.rst b/docs/data-processing/apis/index.rst
@@ -2,8 +2,8 @@
 ..
 .. SPDX-License-Identifier: BSD-3-Clause
 
-**A**\pplication **P**\rogramming **I**\nterface (API)
-======================================================
+Application Programming Interface (API)
+=======================================
 
 APIs can be used to provide the data. :doc:`fastapi/index` is a library that can
 generate APIs and documentation based on `OpenAPI <https://www.openapis.org/>`_

diff --git a/docs/data-processing/geodata.rst b/docs/data-processing/geodata.rst
@@ -473,7 +473,7 @@ Oceanography
        https://raster.shields.io/github/license/mvdh7/PyCO2SYS
 
 `pyoos <https://pypi.org/project/pyoos/>`_
-    High level data collection library for met/ocean data publically available.
+    High level data collection library for met/ocean data publicly available.
 
     .. image::
        https://raster.shields.io/github/stars/ioos/pyoos

diff --git a/docs/data-processing/nosql/column-oriented-db.rst b/docs/data-processing/nosql/column-oriented-db.rst
@@ -38,7 +38,7 @@ Examples of column-oriented database systems are :term:`Cassandra`,
 |                        | *Keyspaces* databases; no      |                                |                                |
 |                        | logical structure, no scheme   |                                |                                |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+
-| **Query langauge**     | `Cassandra Query Language      | `Hypertable Query Language     | Java Client API, Thrift/REST   |
+| **Query language**     | `Cassandra Query Language      | `Hypertable Query Language     | Java Client API, Thrift/REST   |
 |                        | (CQL)`_                        | (HQL)`_                        | API                            |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+
 | **Transactions,        | :term:`Eventual Consistency`   | :term:`MVCC – Multiversion     | :term:`ACID` per line,         |

diff --git a/docs/data-processing/nosql/document-oriented-db.rst b/docs/data-processing/nosql/document-oriented-db.rst
@@ -34,7 +34,7 @@ OrientDB and ArangoDB.
 | **Data model**         | Flexible scheme with           | Flexible scheme                | Essentially                    | Multi-Model                    | Multi-model: documents, graphs |
 |                        | denormalised model             |                                | :term:`Key/Value pair`         |                                | and :term:`Key/value pair`     |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+
-| **Query langauge**     | jQuery, :term:`MapReduce`      | REST, :term:`MapReduce`        | Key filter, :term:`MapReduce`, | `Gremlin`_                     |`ArangoDB Query Language (AQL)`_|
+| **Query language**     | jQuery, :term:`MapReduce`      | REST, :term:`MapReduce`        | Key filter, :term:`MapReduce`, | `Gremlin`_                     |`ArangoDB Query Language (AQL)`_|
 |                        |                                |                                | link walking, no ad-hoc        |                                |                                |
 |                        |                                |                                | queries possible               |                                |                                |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+

diff --git a/docs/data-processing/nosql/graph-db.rst b/docs/data-processing/nosql/graph-db.rst
@@ -70,7 +70,7 @@ Typical graph databases are Neo4j, OrientDB and ArangoDB.
 | **Data model**         | :term:`Property graph model`   | Multi-Model                    | Multi-model: documents, graphs |
 |                        |                                |                                | and :term:`Key/value pair`     |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+
-| **Query langauge**     | REST, `Cypher`_, `Gremlin`_    | `Extended SQL`_, `Gremlin`_    | ArangoDB Query Language (AQL)`_|
+| **Query language**     | REST, `Cypher`_, `Gremlin`_    | `Extended SQL`_, `Gremlin`_    | ArangoDB Query Language (AQL)`_|
 +------------------------+--------------------------------+--------------------------------+--------------------------------+
 | **Transactions,        |* :term:`Two-phase locking      | :term:`ACID`                   | :term:`ACID`,                  |
 | concurrency**          |  (2PL)`                        |                                | :term:`MVCC – Multiversion     |

diff --git a/docs/data-processing/nosql/key-value-store.rst b/docs/data-processing/nosql/key-value-store.rst
@@ -37,7 +37,7 @@ Key/value database systems are e.g. Riak, Cassandra, Redis and MongoDB.
 |                        |                                | to databases; no logical       | lists, sets and sorted sets    |                                |
 |                        |                                | structure, no scheme           |                                |                                |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+
-| **Query langauge**     | Keyfilter, :term:`MapReduce`,  | `Cassandra Query Language      |                                | jQuery, :term:`MapReduce`      |
+| **Query language**     | Keyfilter, :term:`MapReduce`,  | `Cassandra Query Language      |                                | jQuery, :term:`MapReduce`      |
 |                        | Link walking, no ad hoc queries| (CQL)`_                        |                                |                                |
 |                        | possible                       |                                |                                |                                |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+

diff --git a/docs/data-processing/nosql/object-db.rst b/docs/data-processing/nosql/object-db.rst
@@ -70,7 +70,7 @@ Examples of object database systems are ZODB.
 | **Data model**         | PersistentList, PersistentMapping,     |
 |                        | BTree                                  |
 +------------------------+----------------------------------------+
-| **Query langauge**     |                                        |
+| **Query language**     |                                        |
 +------------------------+----------------------------------------+
 | **Transactions,        | :term:`ACID`                           |
 | concurrency**          |                                        |
@@ -81,7 +81,7 @@ Examples of object database systems are ZODB.
 | **Remarks**            |                                        |
 +------------------------+----------------------------------------+
 
-.. _`ZODB`: hhttp://www.zodb.org/
+.. _`ZODB`: https://zodb.org/en/latest/
 .. _`Objectivity/DB`: https://www.objectivity.com/products/objectivitydb/
 .. _`zopefoundation/ZODB`: https://github.com/zopefoundation/ZODB
 .. _`zodb.org/en/latest/tutorial.html`: https://zodb.org/en/latest/tutorial.html

diff --git a/docs/data-processing/nosql/xml-db.rst b/docs/data-processing/nosql/xml-db.rst
@@ -30,7 +30,7 @@ Examples of XML database systems are eXist and MonetDB.
 +------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
 | **Data model**         | XML                                            | XML, column-oriented data structure            | XML                                            |
 +------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
-| **Query langauge**     | :term:`XQuery`, :term:`XPATH`                  | SQL                                            | :term:`XQuery`, :term:`XPATH`                  |
+| **Query language**     | :term:`XQuery`, :term:`XPATH`                  | SQL                                            | :term:`XQuery`, :term:`XPATH`                  |
 +------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
 | **Transactions,        |                                                | :term:`Optimistic Concurrency <Locking>`       | :term:`ACID`, XQuery Locks                     |
 | concurrency**          |                                                |                                                |                                                |

diff --git a/docs/data-processing/pandas-io.rst b/docs/data-processing/pandas-io.rst
@@ -59,7 +59,7 @@ including
 +----------------------------------------------------+------------------------------------------------------------------------------------------+
 | :doc:`pandas:reference/api/pandas.read_sql_table`  | reads an entire SQL table (with                                                          |
 |                                                    | :doc:`postgresql/sqlalchemy`) as a pandas DataFrame                                      |
-|                                                    | (corresponds to a query that selects everything Rin this                                 |
+|                                                    | (corresponds to a query that selects everything in this                                  |
 |                                                    | table with ``read_sql``)                                                                 |
 +----------------------------------------------------+------------------------------------------------------------------------------------------+
 | :doc:`pandas:reference/api/pandas.read_stata`      | reads a data set from the                                                                |

diff --git a/docs/data-processing/postgresql/index.rst b/docs/data-processing/postgresql/index.rst
@@ -5,8 +5,8 @@
 PostgreSQL
 ==========
 
-Basic funtions
---------------
+Basic functions
+---------------
 
 ACID compliant
     ACID (**A** tomicity, **C** onsistency, **I** solation, **D** urability) is

diff --git a/docs/data-processing/postgresql/pganalyze.rst b/docs/data-processing/postgresql/pganalyze.rst
@@ -136,7 +136,7 @@ The result can then look like this, for example:
     2021/02/06 06:40:19 I [server1] Log test successful
 
 If the test was successful, the *Collector* must be restarted for the
-confiugration to take effect:
+configuration to take effect:
 
 .. code-block:: console
 

diff --git a/docs/data-processing/serialisation-formats/json/index.rst b/docs/data-processing/serialisation-formats/json/index.rst
@@ -17,7 +17,7 @@ Overview
 |                       |       | JavaScript: ``NaN`` and ``Infinity`` become ``null``. |
 |                       |       |                                                       |
 |                       |       | Note that the JSON syntax also don’t support comments |
-|                       |       | and you have to work arround for example with a       |
+|                       |       | and you have to work around for example with a        |
 |                       |       | ``__comment__`` key/value pair.                       |
 +-----------------------+-------+-------------------------------------------------------+
 | Standardisation       | \+    | JSON has a formal strongly typed `standard`_ (see     |

diff --git a/docs/data-processing/serialisation-formats/protobuf.rst b/docs/data-processing/serialisation-formats/protobuf.rst
@@ -20,7 +20,7 @@ Overview
 | Language support      | ++    | The protobuf format is well supported by many         |
 |                       |       | programming languages.                                |
 +-----------------------+-------+-------------------------------------------------------+
-| Human readability     | -\-   | Protobuf ist not designed to be human readable.       |
+| Human readability     | -\-   | Protobuf is not designed to be human readable.        |
 +-----------------------+-------+-------------------------------------------------------+
 | Speed                 | ++    | Protobuf is very fast, especially in C++.             |
 +-----------------------+-------+-------------------------------------------------------+

diff --git a/docs/data-processing/serialisation-formats/xml-html/beautifulsoup.ipynb b/docs/data-processing/serialisation-formats/xml-html/beautifulsoup.ipynb
@@ -70,7 +70,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "4. To structure the code, we create a new function `get_dom` (**D**ocument **O**bject **M**odel) that includes all the previous code:"
+    "4. To structure the code, we create a new function `get_dom` (Document Object Model) that includes all the previous code:"
    ]
   },
   {

diff --git a/docs/data-processing/serialisation-formats/yaml/index.rst b/docs/data-processing/serialisation-formats/yaml/index.rst
@@ -14,7 +14,7 @@ Overview
 |                       |       | floats and dates. YAML even supports references and   |
 |                       |       | external data.                                        |
 +-----------------------+-------+-------------------------------------------------------+
-| Standardisation       | \+    | YAML is a strongly tpyed formal standard, but it’s    |
+| Standardisation       | \+    | YAML is a strongly typed formal standard, but it’s    |
 |                       |       | hard to find schema validators.                       |
 +-----------------------+-------+-------------------------------------------------------+
 | Schema-IDL            | +-    | Partly with `Kwalify`_, `Rx`_ and built-in language   |

diff --git a/docs/genindex.rst b/docs/genindex.rst
@@ -2,7 +2,7 @@
 ..
 .. SPDX-License-Identifier: BSD-3-Clause
 
-.. Workarround for displaying the index in the toc
+.. Workaround for displaying the index in the toc
 
 Index
 =====
diff --git a/docs/performance/asyncio-example.ipynb b/docs/performance/asyncio-example.ipynb
@@ -18,7 +18,7 @@
    "source": [
     "If you get  `RuntimeError: This event loop is already running`, [nest-asyncio] might help you.\n",
     "\n",
-    "Ihr könnt das Paket installieren mit\n",
+    "You can install the package with\n",
     "\n",
     "``` bash\n",
     "$ pipenv install nest-asyncio\n",
@@ -246,7 +246,7 @@
    "source": [
     "### Third-party libraries\n",
     "\n",
-    "* [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) has helpfull things like fixtures for `event_loop`, `unused_tcp_port`, and `unused_tcp_port_factory`; and the ability to create your own [asynchronous fixtures](https://pytest-asyncio.readthedocs.io/en/latest/reference/fixtures/index.html).\n",
+    "* [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) has helpful things like fixtures for `event_loop`, `unused_tcp_port`, and `unused_tcp_port_factory`; and the ability to create your own [asynchronous fixtures](https://pytest-asyncio.readthedocs.io/en/latest/reference/fixtures/index.html).\n",
     "* [asynctest](https://asynctest.readthedocs.io/en/latest/index.html) has helpful tooling, including coroutine mocks and [exhaust_callbacks](https://asynctest.readthedocs.io/en/latest/asynctest.helpers.html#asynctest.helpers.exhaust_callbacks) so we don’t have to manually await tasks.\n",
     "* [aiohttp](https://docs.aiohttp.org/en/stable/) has some really nice built-in test utilities."
    ]

diff --git a/docs/productive/envs/index.rst b/docs/productive/envs/index.rst
@@ -13,7 +13,7 @@ the Python package manager :term:`pip`, the call would look like this:
     $ python -m pip install --no-deps --require-hashes ----only-binary=:all:
 
 Dedicated environments (for example with :doc:`pipenv/index`, :term:`devpi` and
-:doc:`Spack <spack/index>` simplify this if you save the file with ther
+:doc:`Spack <spack/index>` simplify this if you save the file with their
 specifications, for example ``Pipfile``, ``Pipfile.lock``, ``package-lock.json``
 :abbr:`etc (et cetera)`. In this way, you and others can reproduce the
 environments.

diff --git a/docs/productive/git/advanced/bisect.rst b/docs/productive/git/advanced/bisect.rst
@@ -48,8 +48,8 @@ This means that only log₂(n+1) commits need to be tested.
 
     $ git show HEAD
     commit 2ddcca36c8bcfa251724fe342c8327451988be0d
-    Autor: Linus Torvalds <[email protected]>
-    Datum: Sa 3. Mai 11:59:44 2008 -0700
+    Author: Linus Torvalds <[email protected]>
+    Date: Sat May 3 11:59:44 2008 -0700
 
         Linux 2.6.26-rc1
 
@@ -64,7 +64,7 @@ This means that only log₂(n+1) commits need to be tested.
     -EXTRAVERSION =
     + SUBLEVEL = 26
     + EXTRAVERSION = -rc1
-     NAME = Funky Weasel ist Jiggy wit it
+     NAME = Funky Weasel is Jiggy with it
 
      # * DOKUMENTATION *
 

diff --git a/docs/productive/git/advanced/hooks/index.rst b/docs/productive/git/advanced/hooks/index.rst
@@ -11,13 +11,13 @@ in a Git repository, including:
 +---------------+-------------------------------------------------------+
 | Command       | Hook                                                  |
 +===============+=======================================================+
-| ``comit``     | ``comit-msg``, ``pre-commit``                         |
+| ``commit``    | ``commit-msg``, ``pre-commit``                        |
 +---------------+-------------------------------------------------------+
-| ``merge``     | ``pre-merge``, ``comit-msg``                          |
+| ``merge``     | ``pre-merge``, ``commit-msg``                         |
 +---------------+-------------------------------------------------------+
 | ``rebase``    | ``pre-rebase``                                        |
 +---------------+-------------------------------------------------------+
-| ``pull``      | ``pre-merge``, ``comit-msg``                          |
+| ``pull``      | ``pre-merge``, ``commit-msg``                         |
 +---------------+-------------------------------------------------------+
 | ``push``      | ``pre-push``                                          |
 +---------------+-------------------------------------------------------+

diff --git a/docs/productive/git/advanced/jupyter-notebooks.rst b/docs/productive/git/advanced/jupyter-notebooks.rst
@@ -191,7 +191,7 @@ Set up
 
          *.ipynb filter=nbstrip_jq
 
-#. If you then use ``git add`` to add your notebok to the stage area, the
+#. If you then use ``git add`` to add your notebook to the stage area, the
    ``nbstrip_jq`` filter will be applied.
 
    .. note::

diff --git a/docs/productive/git/advanced/vs-code/index.rst b/docs/productive/git/advanced/vs-code/index.rst
@@ -48,7 +48,7 @@ select changes. If necessary, you will receive more specific commit actions in
     undo it with :menuselection:`Git: Undo Last Commit` in the
     :menuselection:`Command Palette` (:kbd:`⇧ ⌘ P`).
 
-The sorce control icon in the activity bar on the left shows you how many
+The source control icon in the activity bar on the left shows you how many
 changes you have made in your repository. Selecting the icon will give you a
 more detailed overview of your changes. Selecting a single file will show you
 the line-by-line text changes. You can also use the editor on the right to make

diff --git a/docs/productive/git/install-config.rst b/docs/productive/git/install-config.rst
@@ -355,12 +355,12 @@ among others:
 |     /instance.log             | :file:`logs/instance.log`         | in the root directory of the  |
 |                               |                                   | repository.                   |
 +-------------------------------+-----------------------------------+-------------------------------+
-| .. code-block:: console       | :file:`instance.log`,             | Usualy the pattern match      |
+| .. code-block:: console       | :file:`instance.log`,             | Usually the pattern match     |
 |                               | :file:`logs/instance.log`         | files in any directory.       |
 |     instance.log              |                                   |                               |
 +-------------------------------+-----------------------------------+-------------------------------+
 | .. code-block:: console       | :file:`instance0.log`,            | A question mark fits exactly  |
-|                               | :file:`instance1.log`,            | on a charater.                |
+|                               | :file:`instance1.log`,            | on a character.               |
 |     instance?.log             | but not                           |                               |
 |                               | :file:`instance.log` or           |                               |
 |                               | :file:`instance10.log`            |                               |