docs: fix many spelling mistakes all around.

morian · morian · commit 31051cdfe1e0 · 2026-01-28T23:45:35.000+01:00
Signed-off-by: Romain Bezut &lt;morian@xdec.net&gt;
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -13,7 +13,7 @@ The format is based on `Keep a Changelog`_ and this project adheres to `Semantic
 
 Added
 -----
-- Bring support for Python 3.14 released on october 7th, 2025.
+- Bring support for Python 3.14 released on October 7th, 2025.
 
 
 0.4.5 (2025-09-02)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -9,7 +9,7 @@ Code of Conduct
 This project and everyone participating in it is governed by the `Code of Conduct`_.
 By participating in any way, you are expected to uphold this code.
 
-.. _Code of conduct: https://github.com/morian/aiostem/blob/master/CODE_OF_CONDUCT.md
+.. _Code of Conduct: https://github.com/morian/aiostem/blob/master/CODE_OF_CONDUCT.md
 
 
 Contributions
@@ -43,7 +43,7 @@ If if fixes a non trivial issue with the code, an additional test-case would be
 
    $ make test
 
-I am especially interested in feedbacks on parsing errors from messages coming from Tor, which
+I am especially interested in feedback on parsing errors from messages coming from Tor, which
 may either not be tested beyond what was read on the tests, or on different versions of Tor.
 
 Also, writing documentation is not my favorite cup of tea, all improvements are valuable!
diff --git a/README.rst b/README.rst
@@ -33,7 +33,7 @@ What about Stem?
 ``Stem`` was not meant to be used with asynchronous python and despite `an attempt`_
 to support this framework, it has `never really worked`_ well and was never merged.
 Additionally it does not use a true asynchronous connection but instead uses
-worker threads in order not to break existing codes.
+worker threads in order not to break existing code.
 
 .. _an attempt: https://gitlab.torproject.org/legacy/trac/-/issues/22627
 .. _never really worked: https://github.com/torproject/stem/issues/77
@@ -48,7 +48,7 @@ legacy code, both for a large range of Python versions and support for old versi
 for ``Tor v0.4.5`` and later, as well as Python 3.10 and later.
 
 Additionally, ``stem`` does not provide a low-level API around the control protocol, which
-means that there is time waster registering and unregistering events all around. ``aistem``
+means that there is time wasted registering and unregistering events all around. ``aiostem``
 focuses on a clean implementation of the low level protocol, providing far better performances
 when dealing with a higher number of events.
 
@@ -144,15 +144,15 @@ For further details, please refer to the documentation_.
 Contributing
 ------------
 
-Contributions, bug reports and feedbacks are very welcome, feel free to open
+Contributions, bug reports and feedback are very welcome, feel free to open
 an issue_, send a `pull request`_. or `start a discussion`_.
 
-Participants must uphold the `code of conduct`_.
+Participants must uphold the `Code of Conduct`_.
 
 .. _issue: https://github.com/morian/aiostem/issues/new
 .. _pull request: https://github.com/morian/aiostem/compare/
 .. _start a discussion: https://github.com/morian/aiostem/discussions
-.. _code of conduct: https://github.com/morian/aiostem/blob/master/CODE_OF_CONDUCT.md
+.. _Code of Conduct: https://github.com/morian/aiostem/blob/master/CODE_OF_CONDUCT.md
 
 ``aiostem`` is released under the `MIT license`_.
 
diff --git a/docs/about/protocol.rst b/docs/about/protocol.rst
@@ -1,15 +1,15 @@
 Protocol reference
 ==================
 
-Control port implementation was written based on multiple documentations.
+Control port implementation was written based on multiple documentation sources.
 
 Of course the bible is the `Control Spec`_, published by the `Tor project`_.
 The text version is a little bit easier to deal with compared to the `HTML version`_,
 which was also used for this project.
 
 Due to many questions left after reading these documents, the `source code of Tor`_ was
 also taken into account. It allowed the removal of deprecated commands, replies or events
-when they were removed a long time ago, or sometime are described in the documentation but
+when they were removed a long time ago, or are sometimes described in the documentation but
 were never implemented.
 
 This hopefully ensures a better match between our implementation and the real protocol in Tor.
@@ -19,4 +19,4 @@ This hopefully ensures a better match between our implementation and the real pr
 .. _source code of Tor: https://gitlab.torproject.org/tpo/core/tor
 .. _Tor project: https://www.torproject.org
 
-For any error, please consider :ref:`contributing` though an issue or a pull request.
+For any error, please consider :ref:`contributing` through an issue or a pull request.
diff --git a/docs/reference/event.rst b/docs/reference/event.rst
@@ -5,9 +5,9 @@ Events
 
 .. currentmodule:: aiostem.event
 
-This page describes all the possible events and their parser implementation, received though
+This page describes all the possible events and their parser implementation, received through
 the callbacks registered by :meth:`.Controller.add_event_handler`. Note that all unknown events
-will received an :class:`EventUnknown`, containing the raw :class:`.Message` received.
+will receive an :class:`EventUnknown`, containing the raw :class:`.Message` received.
 
 
 Base classes
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,5 +3,5 @@ sphinx==8.2.3
 sphinx_autodoc_typehints==3.5.2
 sphinx_copybutton==0.5.2
 sphinx_inline_tabs==2025.12.21.14
-sphinx-toolbox==4.1.1
+sphinx-toolbox==4.1.2
 sphinxext_opengraph==0.13.0
diff --git a/docs/tutorial/authenticate.rst b/docs/tutorial/authenticate.rst
@@ -42,7 +42,7 @@ The full list of known authentication methods is documented on :class:`.AuthMeth
 Note here that we use :meth:`~.BaseReply.raise_for_status` here to ensure that the
 command was successful before we go on with :attr:`.ReplyProtocolInfo.data`.
 
-This code, when executed provide an output such as follow:
+This code, when executed provides an output such as follows:
 
 .. code-block:: console
 
diff --git a/docs/tutorial/commands.rst b/docs/tutorial/commands.rst
@@ -30,7 +30,7 @@ from Tor, and then provided back to the caller.
    :emphasize-lines: 18
    :linenos:
 
-Now we can execute the provided code as follow:
+Now we can execute the provided code as follows:
 
 .. code-block:: console
 
@@ -65,7 +65,7 @@ you can also use :meth:`~.Controller.get_info` with the argument ``info/names``.
    :emphasize-lines: 18
    :linenos:
 
-Now we can execute the provided code as follow:
+Now we can execute the provided code as follows:
 
 .. code-block:: console
 
@@ -92,7 +92,7 @@ Now we can execute the provided code as follow:
    -----END RSA PUBLIC KEY-----
    ntor-onion-key C33fH78uZcMwWu9TrOa4WjhQXdqD0ScmjsAxL1kBjVo
    id ed25519 qpL/LxLYVEXghU76iG3LsSI/UW7MBpIROZK0AB18560
-   
+
    version=0.4.8.12
 
 Note that all gathered values are provided as strings and are never interpreted.
@@ -188,4 +188,3 @@ to set the list of redirections for the new onion we are building:
                ),
            ]
            reply = await ctrl.add_onion(key, targets)
-
diff --git a/docs/tutorial/events.rst b/docs/tutorial/events.rst
@@ -51,5 +51,5 @@ Its intended use is as follow:
 
 The callback method provided here can be either synchronous or asynchronous, but you need
 to take extra care here since the callback methods run directly from the stream reader task.
-If you need extract time, consider putting items in an :class:`asyncio.Queue` and handle
+If you need extra time, consider putting items in an :class:`asyncio.Queue` and handle
 events in a separate task.
diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
@@ -26,7 +26,7 @@ From PyPi
 
 ``aiostem`` can be installed from PyPi::
 
-   ptyhon -m pip install aiostem
+   python -m pip install aiostem
 
 The wheel package is generic and should work on most platforms.
 
@@ -51,4 +51,3 @@ Tutorial
    commands
    events
    monitor
-
