Skip to content

Commit d1cbc10

Browse files
authored
Merge pull request ckan#6284 from EricSoroos/interface_docs
Updated Docstrings for after_update/after_delete
2 parents 85e8380 + 7586be1 commit d1cbc10

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

ckan/plugins/interfaces.py

+13
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,11 @@ def after_dataset_update(
494494
u'''
495495
Extensions will receive the validated data dict after the dataset
496496
has been updated.
497+
498+
Note that bulk dataset update actions (`bulk_update_private`,
499+
`bulk_update_public`) will bypass this callback. See
500+
``ckan.plugins.toolkit.chained_action`` to wrap those actions
501+
if required.
497502
'''
498503
pass
499504

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

@@ -631,6 +640,10 @@ def after_resource_update(
631640
dictionary ``url_type`` which is set to ``upload`` when the
632641
resource file is uploaded instead of linked.
633642
:type resource: dictionary
643+
644+
Note that the datastore will bypass this callback when updating
645+
the ``datastore_active`` flag on a resource that has been added
646+
to the datastore.
634647
'''
635648
pass
636649

0 commit comments

Comments
 (0)