Skip to content

Commit

Permalink
reformat IDomainObjectModification docstrings
Browse files Browse the repository at this point in the history
remove reference to SearchIndexError because this is the wrong place
to abort operations, see IDatasetForm for validation errors instead
  • Loading branch information
wardi committed Mar 8, 2016
1 parent 1b6d5d9 commit 41aeabc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions ckan/plugins/interfaces.py
Expand Up @@ -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

Expand Down

0 comments on commit 41aeabc

Please sign in to comment.