From 41aeabc52389ad9447e22bd6f3fe22d14ef0d1a7 Mon Sep 17 00:00:00 2001 From: Ian Ward Date: Tue, 8 Mar 2016 09:16:56 -0500 Subject: [PATCH] reformat IDomainObjectModification docstrings remove reference to SearchIndexError because this is the wrong place to abort operations, see IDatasetForm for validation errors instead --- ckan/plugins/interfaces.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ckan/plugins/interfaces.py b/ckan/plugins/interfaces.py index 3cc1fb43467..65bc014900c 100644 --- a/ckan/plugins/interfaces.py +++ b/ckan/plugins/interfaces.py @@ -180,19 +180,19 @@ class IDomainObjectModification(Interface): def notify(self, entity, operation): """ - Give user a notify according to different user operation on current entity. If fail raise a Searc hIndexError. + Send a notification on entity modification. :param entity: instance of module.Package. - :param operation: instance of DomainObjectOperation, type enum, can be 'new', 'changed' or 'deleted'. + :param operation: 'new', 'changed' or 'deleted'. """ pass def notify_after_commit(self, entity, operation): """ - Give user a notify according to different user operation on current entity after user action. + Send a notification after entity modification. :param entity: instance of module.Package. - :param operation: instance of DomainObjectOperation, type enum, can be 'new', 'changed' or 'deleted'. + :param operation: 'new', 'changed' or 'deleted'. """ pass