From af9073210b930dc0e731b606f1c0d8b879ffb75e Mon Sep 17 00:00:00 2001 From: Igor Milhit Date: Mon, 8 Jul 2019 12:03:35 +0200 Subject: [PATCH] documentation: rewrite bad syntax in docstrings Co-Authored-by: Igor Milhit --- rero_ils/modules/documents/listener.py | 9 ++++----- rero_ils/modules/items/listener.py | 9 ++++----- rero_ils/modules/loans/listener.py | 9 ++++----- rero_ils/modules/locations/listener.py | 9 ++++----- rero_ils/modules/notifications/listener.py | 9 ++++----- rero_ils/modules/patrons/listener.py | 9 ++++----- 6 files changed, 24 insertions(+), 30 deletions(-) diff --git a/rero_ils/modules/documents/listener.py b/rero_ils/modules/documents/listener.py index 83b30875db..7b8b865797 100644 --- a/rero_ils/modules/documents/listener.py +++ b/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 diff --git a/rero_ils/modules/items/listener.py b/rero_ils/modules/items/listener.py index b00f851b4b..df3281f668 100644 --- a/rero_ils/modules/items/listener.py +++ b/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): diff --git a/rero_ils/modules/loans/listener.py b/rero_ils/modules/loans/listener.py index 6cf4db7ce2..9c17ffca4d 100644 --- a/rero_ils/modules/loans/listener.py +++ b/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): diff --git a/rero_ils/modules/locations/listener.py b/rero_ils/modules/locations/listener.py index df11ca6d44..9141fa77d1 100644 --- a/rero_ils/modules/locations/listener.py +++ b/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): diff --git a/rero_ils/modules/notifications/listener.py b/rero_ils/modules/notifications/listener.py index d7664aae09..b9fa5a4ade 100644 --- a/rero_ils/modules/notifications/listener.py +++ b/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): diff --git a/rero_ils/modules/patrons/listener.py b/rero_ils/modules/patrons/listener.py index 8373506c24..63d4056bbc 100644 --- a/rero_ils/modules/patrons/listener.py +++ b/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):