Fix typos detected by the typos tool (#1330)

* typos: apply automatic corrections

* typos: apply manual corrections

* typos: run as linter

* typos: apply automatic corrections in releasenotes/

* typos: also check releasenotes content

* Add release notes fragment

* workflows/main: add spell check

* Fix docs build

* typos: upgrade to 1.28

* workflows/main: pin rust to 1.82

* workflows/main: remove spell check

* Use Rust stable again

* Typos: dedicated nox command

* Move typos configuration to pyproject.toml

---------

Co-authored-by: Ivan Carvalho <[email protected]>
Co-authored-by: Ivan Carvalho <[email protected]>

Author: airwoodix

.github/workflows/main.yml

@@ -29,7 +29,7 @@ jobs:
       - run: pip install -U ruff==0.6.8 black~=24.8
       - uses: dtolnay/rust-toolchain@stable
         with:
-          components: rustfmt
+          components: rustfmt, clippy
       - name: Test Build
         run: cargo build
       - name: Rust Format

CONTRIBUTING.md

@@ -284,7 +284,7 @@ cargo doc --open
 ### Type Annotations
 
 If you have added new methods, functions, or classes, and/or changed any
-signatures, type anotations for Python are required to be included in a pull
+signatures, type annotations for Python are required to be included in a pull
 request. Type annotations are added using type
 [stub files](https://typing.readthedocs.io/en/latest/source/stubs.html) which
 provide type annotations to python tooling which use type annotations. The stub
@@ -523,7 +523,7 @@ primary exception to this is adding support for new python versions. If a new
 python version is released backporting that feature change with that new support
 is an acceptable backport.
 
-In rustworkx at least until the 1.0 release we only maintaing a single stable
+In rustworkx at least until the 1.0 release we only maintain a single stable
 branch at a time for the most recent minor version release.
 
 #### Backporting procedure

README.md

@@ -77,7 +77,7 @@ it just as it would if there was a prebuilt binary available.
 > [!NOTE]  
 > To build from source you will need to ensure you have pip >=19.0.0
 installed, which supports PEP-517, or that you have manually installed
-`setuptools-rust` prior to running `pip install rustworkx`. If you recieve an
+`setuptools-rust` prior to running `pip install rustworkx`. If you receive an
 error about `setuptools-rust` not being found you should upgrade pip with
 `pip install -U pip` or manually install `setuptools-rust` with
 `pip install setuptools-rust` and try again.

docs/source/benchmarks.rst

@@ -2,7 +2,7 @@
 Rustworkx Comparison Benchmarks With Other Libraries
 ****************************************************
 
-rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility <https://github.com/mtreinish/retworkx-comparison-benchmarks>`__. We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 theads, and 32GB of RAM avaialble. 
+rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility <https://github.com/mtreinish/retworkx-comparison-benchmarks>`__. We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 threads, and 32GB of RAM available.
 
 Graph Creation
 ==============

docs/source/install.rst

@@ -44,12 +44,12 @@ just as it would if there was a prebuilt binary available.
 
     To build from source you will need to ensure you have pip >=19.0.0
     installed, which supports PEP-517, or that you have manually installed
-    setuptools-rust prior to running pip install rustworkx. If you recieve an
+    setuptools-rust prior to running pip install rustworkx. If you receive an
     error about ``setuptools-rust`` not being found you should upgrade pip with
     ``pip install -U pip`` or manually install ``setuptools-rust`` with:
     ``pip install setuptools-rust`` and try again.
 
-.. _platform-suppport:
+.. _platform-support:
 
 Platform Support
 ================

docs/source/release_notes.rst

@@ -266,7 +266,7 @@ New Features
 
 - A new method, :meth:`~rustworkx.PyDiGraph.remove_node_retain_edges`, has been
   added to the :class:`~rustworkx.PyDiGraph` class. This method can be used to
-  remove a node and add edges from its predecesors to its successors.
+  remove a node and add edges from its predecessors to its successors.
 - Two new methods, :meth:`~rustworkx.PyGraph.edge_list` and
   :meth:`~rustworkx.PyGraph.weighted_edge_list`, for getting a list of tuples
   with the edge source and target (with or without edge weights) have been
@@ -285,7 +285,7 @@ New Features
   edge list file and will read that file and generate a new object from the
   contents.
 - Two new methods, :meth:`~rustworkx.PyGraph.extend_from_edge_list` and
-  :meth:`~rustworkx.PyGraoh.extend_from_weighted_edge_list` has been added
+  :meth:`~rustworkx.PyGraph.extend_from_weighted_edge_list` has been added
   to :class:`~rustworkx.PyGraph` and :class:`~rustworkx.PyDiGraph`
   (:meth:`~rustworkx.PyDiGraph.extend_from_edge_list` and
   :meth:`~rustworkx.PyDiGraph.extend_from_weighted_edge_list`). This method

docs/source/tutorial/betweenness_centrality.rst

@@ -37,8 +37,8 @@ To start we need to generate a graph:
     mpl_draw(graph)
 
 
-Calculate the Betweeness Centrality
------------------------------------
+Calculate the Betweenness Centrality
+------------------------------------
 
 The :func:`~rustworkx.betweenness_centrality` function can be used to calculate
 the betweenness centrality for each node in the graph.

docs/source/tutorial/dags.rst

@@ -113,7 +113,7 @@ jobs. For example:
 Above we define a DAG with 6 jobs and dependency relationship between these
 jobs. Now if we run the :func:`~rustworkx.topological_sort` function on the
 graph it will return a linear order to execute the jobs that will respect
-the dependency releationship.
+the dependency relationship.
 
 .. jupyter-execute::
 
@@ -151,7 +151,7 @@ computation. A quantum circuit is represented graphically like:
 
 The specifics of this circuit aren't important here beyond the fact that
 we have 2 qubits, ``q_0`` and ``q_1``, 2 classical bits, ``c_0`` and ``c_1``,
-and a series of operations on those qubits with a depedency ordering. The last
+and a series of operations on those qubits with a dependency ordering. The last
 operation on each qubit is a measurement on ``q_0`` that is stored in ``c_0``
 and ``q_1`` that is stored in ``c_1``.
 

noxfile.py

@@ -15,6 +15,7 @@
     "black~=24.8",
     "ruff~=0.6",
     "setuptools-rust",
+    "typos~=1.28",
 ]
 
 stubs_deps = [
@@ -45,6 +46,7 @@ def test_with_version(session):
 @nox.session(python=["3"])
 def lint(session):
     black(session)
+    typos(session)
     session.install(*lint_deps)
     session.run("ruff", "check", "rustworkx", "retworkx", "setup.py")
     session.run("cargo", "fmt", "--all", "--", "--check", external=True)
@@ -69,6 +71,12 @@ def black(session):
     session.install(*[d for d in lint_deps if "black" in d])
     session.run("black", "rustworkx", "tests", "retworkx", *session.posargs)
 
+@nox.session(python=["3"])
+def typos(session):
+    session.install(*[d for d in lint_deps if "typos" in d])
+    session.run("typos", "--exclude", "releasenotes")
+    session.run("typos", "--no-check-filenames", "releasenotes")
+
 @nox.session(python=["3"])
 def stubs(session):
     install_rustworkx(session)

pyproject.toml

@@ -23,6 +23,11 @@ extend-exclude = ["doc"]
 "rustworkx/__init__.py" = ["F405", "F403"]
 "*.pyi" = ["F403", "F405", "PYI001", "PYI002"]
 
+[tool.typos.default]
+extend-ignore-words-re = [
+  "[Ss]toer",
+]
+
 [tool.cibuildwheel]
 manylinux-x86_64-image = "manylinux2014"
 manylinux-i686-image = "manylinux2014"