From 648f6f94ebcf20169e423252ec81970233f78e9c Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Fri, 5 Jul 2024 18:19:04 -0400 Subject: [PATCH] [docs] Minor improvements --- docs/developer/extending.rst | 6 +++--- docs/developer/utils.rst | 8 ++++---- docs/user/intro.rst | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developer/extending.rst b/docs/developer/extending.rst index fd8941ada..0c56199b2 100644 --- a/docs/developer/extending.rst +++ b/docs/developer/extending.rst @@ -17,9 +17,9 @@ serve you as source of truth: just replicate and adapt that code to get a basic derivative of *OpenWISP Controller* working. If you want to add new users fields, please follow the :doc:`tutorial to extend the -openwisp-users module `. As an -example, we have extended *openwisp-users* to *sample_users* app and added a field -``social_security_number`` in the `sample_users/models.py +openwisp-users module `. As an example, we have extended +*openwisp-users* to *sample_users* app and added a field ``social_security_number`` in +the `sample_users/models.py `_. **Premise**: if you plan on using a customized version of this module, we suggest to diff --git a/docs/developer/utils.rst b/docs/developer/utils.rst index b618d5183..bf242c751 100644 --- a/docs/developer/utils.rst +++ b/docs/developer/utils.rst @@ -75,10 +75,10 @@ For more information, see the relevant :doc:`documentation section about registe notification types in the Notifications module `. -Once a new notification type is registered, you have to use the :doc:`"notify" signal -provided the Notifications module -` to send -notifications for this type. +Once a new notification type is registered, you can use +the :doc:`"notify" signal provided by the Notifications module +` to send notifications +with this new type. Signals ------- diff --git a/docs/user/intro.rst b/docs/user/intro.rst index f4aaa7451..cf7b56905 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -79,8 +79,8 @@ SNMP ~~~~ The SNMP connector is useful to collect monitoring information and it's used in -:doc:`OpenWISP Monitoring ` for performing -checks to collect monitoring information. `Read more +:doc:`OpenWISP Monitoring ` for performing checks to collect +monitoring information. `Read more `_ on how to use it.