Skip to content

Commit

Permalink
Updated Docstrings for after_update/after_delete
Browse files Browse the repository at this point in the history
* The after_update and after_delete callbacks aren't always called
when the underlying dataset changes. This enumerates the cases where
it happens, and what to do about it.
  • Loading branch information
EricSoroos committed Nov 10, 2023
1 parent f922ec9 commit bf94b96
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions ckan/plugins/interfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,11 @@ def after_dataset_update(
u'''
Extensions will receive the validated data dict after the dataset
has been updated.
Note that bulk dataset update actions (`bulk_update_private`,
`bulk_update_public`) will bypass this callback. See
``ckan.plugins.toolkit.chained_action`` to wrap those actions
if required.
'''
pass

Expand All @@ -502,6 +507,10 @@ def after_dataset_delete(
u'''
Extensions will receive the data dict (typically containing
just the dataset id) after the dataset has been deleted.
Note that the `bulk_update_delete` action will bypass this
callback. See ``ckan.plugins.toolkit.chained_action`` to wrap
that action if required.
'''
pass

Expand Down

0 comments on commit bf94b96

Please sign in to comment.