documentation: rewrite bad syntax in docstrings

Co-Authored-by: Igor Milhit <[email protected]>

rero_ils/modules/documents/listener.py

@@ -40,11 +40,10 @@ def enrich_document_data(sender, json=None, record=None, index=None,
                          **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params json: The dumped record dictionary which can be modified.
+    :params record: The record being indexed.
+    :params index: The index in which the record will be indexed.
+    :params doc_type: The doc_type for the record.
     """
     # TODO: this multiply the indexing time by 5, try an other way!
     document_index_name = DocumentsSearch.Meta.index

rero_ils/modules/items/listener.py

@@ -31,11 +31,10 @@ def enrich_item_data(sender, json=None, record=None, index=None,
                      **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params json: The dumped record dictionary which can be modified.
+    :params record: The record being indexed.
+    :params index: The index in which the record will be indexed.
+    :params doc_type: The doc_type for the record.
     """
     item_index_name = ItemsSearch.Meta.index
     if index.startswith(item_index_name):

rero_ils/modules/loans/listener.py

@@ -35,11 +35,10 @@ def enrich_loan_data(sender, json=None, record=None, index=None,
                      **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params json: The dumped record dictionary which can be modified.
+    :params record: The record being indexed.
+    :params index: The index in which the record will be indexed.
+    :params doc_type: The doc_type for the record.
     """
     loan_index_name = current_circulation.loan_search.Meta.index
     if index.startswith(loan_index_name):

rero_ils/modules/locations/listener.py

@@ -31,11 +31,10 @@ def enrich_location_data(sender, json=None, record=None, index=None,
                          **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params json: The dumped record dictionary which can be modified.
+    :params record: The record being indexed.
+    :params index: The index in which the record will be indexed.
+    :params doc_type: The doc_type for the record.
     """
     location_index_name = LocationsSearch.Meta.index
     if index.startswith(location_index_name):

rero_ils/modules/notifications/listener.py

@@ -31,11 +31,10 @@ def enrich_notification_data(sender, json=None, record=None, index=None,
                              **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params json: The dumped record dictionary which can be modified.
+    :params record: The record being indexed.
+    :params index: The index in which the record will be indexed.
+    :params doc_type: The doc_type for the record.
     """
     notification_index_name = NotificationsSearch.Meta.index
     if index.startswith(notification_index_name):

rero_ils/modules/patrons/listener.py

@@ -66,11 +66,10 @@ def enrich_patron_data(sender, json=None, record=None, index=None,
                        **dummy_kwargs):
     """Signal sent before a record is indexed.
 
-    Arguments:
-    - ``json``: The dumped record dictionary which can be modified.
-    - ``record``: The record being indexed.
-    - ``index``: The index in which the record will be indexed.
-    - ``doc_type``: The doc_type for the record.
+    :params: json: The dumped record dictionary which can be modified.
+    :params: record: The record being indexed.
+    :params: index: The index in which the record will be indexed.
+    :params: doc_type: The doc_type for the record.
     """
     patron_index_name = PatronsSearch.Meta.index
     if index.startswith(patron_index_name):