[docs] Spell check

CHANGES.rst

@@ -143,7 +143,7 @@ Features
 - [utils] Added `register_menu_items
   <https://github.com/openwisp/openwisp-utils#openwisp-utils-utils-register-menu-items>`_
   to easily register menu items
-- [tests] Added test utilities to capture output (eg: to make assertions
+- [tests] Added test utilities to capture output (e.g.: to make assertions
   on it): `capture_stdout
   <https://github.com/openwisp/openwisp-utils#openwisp-utils-tests-capture-stdout>`_,
   `capture_stderr

docs/developer/admin-theme.rst

@@ -134,8 +134,8 @@ Allows adding items to :ref:`OPENWISP_ADMIN_THEME_LINKS
 <openwisp_admin_theme_links>`.
 
 This function is meant to be used by third party apps or OpenWISP modules
-which aim to extend the core look and feel of the OpenWISP theme (eg: add
-new menu icons).
+which aim to extend the core look and feel of the OpenWISP theme (e.g.:
+add new menu icons).
 
 **Syntax:**
 
@@ -157,8 +157,8 @@ Allows removing items from :ref:`OPENWISP_ADMIN_THEME_LINKS
 <openwisp_admin_theme_links>`.
 
 This function is meant to be used by third party apps or OpenWISP modules
-which aim additional functionalities to UI of OpenWISP (eg: adding a
-support chatbot).
+which aim additional functionalities to UI of OpenWISP (e.g.: adding a
+support chat bot).
 
 **Syntax:**
 
@@ -219,7 +219,7 @@ Sending emails
 +++++++++++++++++++++++++++++++++++++++++++++++
 
 This function allows sending email in both plain text and HTML version
-(using the template and logo that can be customised using
+(using the template and logo that can be customized using
 :ref:`OPENWISP_EMAIL_TEMPLATE <openwisp_email_template>` and
 :ref:`OPENWISP_EMAIL_LOGO <openwisp_email_logo>` respectively).
 

docs/developer/admin-utilities.rst

@@ -10,7 +10,7 @@ Admin Utilities
 ``openwisp_utils.admin.TimeReadonlyAdminMixin``
 -----------------------------------------------
 
-Admin mixin which adds two readonly fields ``created`` and ``modified``.
+Admin mixin which adds two read only fields ``created`` and ``modified``.
 
 This is an admin mixin for models inheriting ``TimeStampedEditableModel``
 which adds the fields ``created`` and ``modified`` to the database.
@@ -21,7 +21,7 @@ which adds the fields ``created`` and ``modified`` to the database.
 A read-only ``ModelAdmin`` base class.
 
 Will include the ``id`` field by default, which can be excluded by
-supplying the ``exclude`` attribute, eg:
+supplying the ``exclude`` attribute, e.g.:
 
 .. code-block:: python
 
@@ -101,7 +101,8 @@ object. Following is an example:
 --------------------------------------------------
 
 The ``admin_theme`` sub app of this package provides an input filter that
-can be used in changelist page to filter ``UUIDField`` or ``CharField``.
+can be used in the *changelist* page to filter ``UUIDField`` or
+``CharField``.
 
 Code example:
 
@@ -186,7 +187,7 @@ following example:
 ---------------------------------------------------------
 
 The ``admin_theme`` sub app of this package provides an auto complete
-filter that uses django autocomplete widget to load filter data
+filter that uses the *django-autocomplete* widget to load filter data
 asynchronously.
 
 This filter can be helpful when the number of objects is too large to load

docs/developer/installation.rst

@@ -54,9 +54,9 @@ Install development dependencies:
     pip install -r requirements-test.txt
     sudo npm install -g jshint stylelint
 
-Set up the pre-push hook to run tests and QA checks automatically right
-before the git push action, so that if anything fails the push operation
-will be aborted:
+Set up the git *pre-push* hook to run tests and QA checks automatically
+right before the git push action, so that if anything fails the push
+operation will be aborted:
 
 .. code-block:: shell
 
@@ -96,7 +96,7 @@ Alternative Sources
 Pypi
 ~~~~
 
-To install the latest stable version from pypi:
+To install the latest Pypi:
 
 .. code-block:: shell
 

docs/developer/navigation-menu.rst

@@ -50,11 +50,11 @@ the Main Navigation Menu.
 
     register_menu_group(position, config)
 
-============= =============================================
+============= ==============================================
 **Parameter** **Description**
 ``position``  (``int``) Position of the group or item.
-``config``    (``dict``) Configuration of the goup or item.
-============= =============================================
+``config``    (``dict``) Configuration of the group or item.
+============= ==============================================
 
 Code example:
 
@@ -136,7 +136,7 @@ Following is the description of the configuration:
 ============= ============================================================
 **Parameter** **Description**
 ``label``     (``str``) Display text for the link.
-``url``       (``str``) url for the link.
+``url``       (``str``) URL for the link.
 ``icon``      An **optional** ``str`` CSS class name for the icon. No icon
               is displayed if not provided.
 ============= ============================================================
@@ -179,7 +179,7 @@ Following is the description of the configuration:
 ============= ============================================================
 **Parameter** **Description**
 ``model``     (``str``) Model of the app for which you to add link.
-``name``      (``str``) url name. eg. changelist or add.
+``name``      (``str``) argument name, e.g.: *changelist* or *add*.
 ``label``     An **optional** ``str`` display text for the link. It is
               automatically generated if not provided.
 ``icon``      An **optional** ``str`` CSS class name for the icon. No icon

docs/developer/other-utilities.rst

@@ -153,7 +153,7 @@ If you want to print a string in ``Red Bold``, you can do it as below.
 
     print_color("This is the printed in Red Bold", color_name="red_bold")
 
-You may also provide the ``end`` arguement similar to built-in print
+You may also provide the ``end`` argument similar to built-in print
 method.
 
 ``openwisp_utils.utils.SorrtedOrderedDict``
@@ -189,7 +189,7 @@ Usage:
 
 **Note:** This task class should be used for regular background tasks but
 not for complex background tasks which can take a long time to execute
-(eg: firmware upgrades, network operations with retry mechanisms).
+(e.g.: firmware upgrades, network operations with retry mechanisms).
 
 ``openwisp_utils.utils.retryable_request``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -249,7 +249,7 @@ Usage:
 - ``**kwargs``: Additional keyword arguments to be passed to the
   underlying request method (e.g. 'headers', etc.).
 
-This method will raise a requests.exceptions.RetryError if the request
+This method will raise a ``requests.exceptions.RetryError`` if the request
 remains unsuccessful even after all retry attempts have been exhausted.
 This exception indicates that the operation could not be completed
 successfully despite the retry mechanism.

docs/developer/qa-checks.rst

@@ -35,7 +35,7 @@ Shell script to run the following quality assurance checks:
 - :ref:`checkpendingmigrations <utils_checkpendingmigrations>`
 - :ref:`checkrst <utils_checkrst>`
 - ``flake8`` - Python code linter
-- ``isort`` - Sorts python imports alphabetically, and seperated into
+- ``isort`` - Sorts python imports alphabetically, and separated into
   sections
 - ``black`` - Formats python code using a common standard
 - ``csslinter`` - Formats and checks CSS code using stylelint common
@@ -59,7 +59,7 @@ Usage example:
     openwisp-qa-check --skip-isort
 
 For backward compatibility ``csslinter`` and ``jslinter`` are skipped by
-default. To run them in checks pass arguements in this way.
+default. To run them during QA checks pass arguments as follows.
 
 Usage example:
 
@@ -156,7 +156,7 @@ Ensures there django migrations are up to date and no new migrations need
 to be created.
 
 It accepts an optional ``--migration-module`` flag indicating the django
-app name that should be passed to ``./manage.py makemigrations``, eg:
+app name that should be passed to ``./manage.py makemigrations``, e.g.:
 ``./manage.py makemigrations $MIGRATION_MODULE``.
 
 .. _utils_checkrst:
@@ -165,4 +165,4 @@ app name that should be passed to ``./manage.py makemigrations``, eg:
 ------------
 
 Checks the syntax of all ReStructuredText files to ensure they can be
-published on pypi or using python-sphinx.
+published on Pypi or using python-sphinx.

docs/developer/test-utilities.rst

@@ -10,7 +10,7 @@ Test Utilities
 ``openwisp_utils.tests.catch_signal``
 -------------------------------------
 
-This method can be used to mock a signal call inorder to easily verify
+This method can be used to mock a signal call in order to easily verify
 that the signal has been called.
 
 Usage example as a context-manager:

docs/partials/developer-docs.rst

@@ -2,7 +2,7 @@
 
     This documentation page is aimed at developers who want to customize,
     change or extend the code of OpenWISP Utils in order to modify its
-    behavior (eg: for personal or commercial purposes or to fix a bug,
+    behavior (e.g.: for personal or commercial purposes or to fix a bug,
     implement a new feature or contribute to the project in general).
 
     If you aren't a developer and you are looking for information on how

docs/user/admin-filters.rst

@@ -4,7 +4,7 @@ Admin Filters
 .. figure:: https://raw.githubusercontent.com/openwisp/openwisp-utils/media/docs/filter.gif
     :align: center
 
-The ``admin_theme`` sub app provides an improved UI for the changelist
+The ``admin_theme`` sub app provides an improved UI for the *changelist*
 filter which occupies less space compared to the original implementation
 in django: filters are displayed horizontally on the top (instead of
 vertically on the side) and filter options are hidden in dropdown menus

docs/user/settings.rst

@@ -129,7 +129,7 @@ Whether the OpenAPI documentation is enabled.
 When enabled, you can view the available documentation using the Swagger
 endpoint at ``/api/v1/docs/``.
 
-You also need to add the following url to your project urls.py:
+You also need to add the following URL to your project ``urls.py``:
 
 .. code-block:: python
 
@@ -167,7 +167,7 @@ documentation
 It can be used to change the thresholds used by
 :ref:`TimeLoggingTestRunner <utils_time_logging_test_runner>` to detect
 slow tests (0.3s by default) and highlight the slowest ones (1s by
-default) amongst them.
+default) among them.
 
 .. _openwisp_staticfiles_versioned_exclude: