Skip to content

Commit

Permalink
[docs] Spell check
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Aug 6, 2024
1 parent 1c090fa commit 272414d
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 16 deletions.
9 changes: 4 additions & 5 deletions docs/developer/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ the `"First steps with Django" section in the celery documentation
14. Import Celery Tasks
-----------------------

Add the following in your settings.py to import celery tasks from
Add the following in your ``settings.py`` to import Celery tasks from
``openwisp_notifications`` app.

.. code-block:: python
Expand All @@ -282,9 +282,8 @@ Add the following in your settings.py to import celery tasks from
15. Register Template Tags
--------------------------

If you need to use template tags of *openwisp_notifications*, you will
need to register as shown in `"templatetags/notification_tags.py" of
sample_notifications
If you need to use template tags, you will need to register them as shown
in `"templatetags/notification_tags.py" of sample_notifications
<https://github.com/openwisp/openwisp-notifications/blob/master/tests/openwisp2/sample_notifications/templatetags/notification_tags.py>`_.

For more information about template tags in django, please refer to the
Expand Down Expand Up @@ -322,7 +321,7 @@ See the `tests of the sample_notifications
to find out how to do this.

**Note**: Some tests will fail if ``templatetags`` and ``admin/base.html``
are not configured properly. See preceeding sections to configure them
are not configured properly. See preceding sections to configure them
properly.

Other base classes that can be inherited and extended
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Alternative Sources
Pypi
~~~~

To install the latest stable version from pypi:
To install the latest Pypi:

.. code-block:: shell
Expand Down
9 changes: 3 additions & 6 deletions docs/partials/developer-docs.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
.. note::

This documentation page is aimed at developers who want to customize,
change or extend the code of OpenWISP Notifications in order to modify
its behavior (eg: for personal or commercial purposes or to fix a bug,
implement a new feature or contribute to the project in general).
This page is for developers who want to customize or extend OpenWISP
Notifications, whether for bug fixes, new features, or contributions.

If you aren't a developer and you are looking for information on how
to use OpenWISP, please refer to:
For user guides and general information, please see:

- :doc:`General OpenWISP Quickstart </user/quickstart>`
- :doc:`OpenWISP Notifications User Docs </notifications/index>`
2 changes: 1 addition & 1 deletion docs/user/scheduled-deletion-of-notifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Scheduled Deletion of Notifications
OpenWISP, or who have deployed OpenWISP in a different way.

OpenWISP Notifications provides a celery task to automatically delete
notifications older than a pre-configured number of days. In order to run
notifications older than a preconfigured number of days. In order to run
this task periodically, you will need to configure
``CELERY_BEAT_SCHEDULE``.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/sending-notifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The ``notify`` signal supports the following additional parameters:
``email_subject`` Sets subject of email notification to be sent.

Defaults to the notification message.
``url`` Adds a URL in the email text, eg:
``url`` Adds a URL in the email text, e.g.:

``For more information see <url>.``

Expand Down
2 changes: 1 addition & 1 deletion docs/user/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ default `notification_bell.mp3
This setting defines notification sound to be played when notification is
received in real-time on admin site.

Provide a relative path (hosted on your webserver) to audio file as show
Provide a relative path (hosted on your web server) to audio file as show
below.

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/user/web-email-notifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Notification Widget
A JavaScript widget has been added to make consuming notifications easy
for users. The notification widget provides the following features:

- A minimalistic UI to help users complete tasks quickly.
- User Interface to help users complete tasks quickly.
- Dynamically loads notifications with infinite scrolling to prevent
unnecessary network requests.
- Option to filter unread notifications.
Expand Down

0 comments on commit 272414d

Please sign in to comment.