Skip to content

Commit 72a9890

Browse files
docs: clarify event details
1 parent 160a649 commit 72a9890

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

src/openedx_content/applets/publishing/signals.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,20 @@ class DraftChangeLogEventData:
7373
"""
7474
The draft version of one or more entities in a `LearningPackage` has changed.
7575
76-
This is emitted for when the first version of an entity is created, when a new
77-
version of an entity is created (i.e. the entity is modified), when an entity is
78-
reverted to an old version, or when an entity is deleted. (All referring to the
79-
draft version of the entity.)
76+
This is emitted for when the first version of an entity is **created**, when a
77+
new version of an entity is created (i.e. an entity is **modified**), when an
78+
entity is **reverted** to an old version, or when an entity is **deleted**.
79+
(All referring to the draft version of the entity.) The ``old_version`` and
80+
``new_version`` fields can be used to distinguish among these cases.
8081
8182
This is a low-level batch event. It does not have any course or library context
8283
information available. It does not distinguish between Containers, Components,
8384
or other entity types.
8485
8586
Collections and tags are not `PublishableEntity`-based, so do not participate in
8687
this event.
88+
89+
⏳ This **batch** event is emitted **synchronously**. Handlers that do anything
90+
per-entity or that is possibly slow should dispatch an asynchronous task for
91+
processing the event.
8792
"""

0 commit comments

Comments
 (0)