docs: update warnings about event bus compatibility with more info

openedx · Jan 16, 2025 · be06179 · be06179
1 parent c0d9328
commit be06179
Showing 1 changed file with 13 additions and 7 deletions.
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -181,7 +181,8 @@
 # .. event_type: org.openedx.learning.discussions.configuration.changed.v1
 # .. event_name: COURSE_DISCUSSIONS_CHANGED
 # .. event_description: Emitted when the configuration for a course's discussions changes in the course.
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, list with complex types
+#      like ``List[DiscussionTopicContext]`` cannot be serialized yet.
 # .. event_data: CourseDiscussionConfigurationData
 # .. event_trigger_repository: openedx/edx-platform
 COURSE_DISCUSSIONS_CHANGED = OpenEdxPublicSignal(
@@ -221,7 +222,8 @@
 # .. event_name: USER_NOTIFICATION_REQUESTED
 # .. event_description: Can be emitted from apps to send user notifications.
 # .. event_data: UserNotificationSendListData
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, list without annotations
+#      are not serializable.
 # .. event_trigger_repository: openedx/edx-platform openedx/edx-ora2
 USER_NOTIFICATION_REQUESTED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.user.notification.requested.v1",
@@ -320,7 +322,8 @@
 # .. event_description: Emitted when a new thread is created in a discussion.
 # .. event_data: DiscussionThreadData
 # .. event_trigger_repository: openedx/edx-platform
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, dict without annotations
+#      are not serializable.
 FORUM_THREAD_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.forum.thread.created.v1",
     data={
@@ -333,7 +336,8 @@
 # .. event_description: Emitted when a new response is added to a thread.
 # .. event_data: DiscussionThreadData
 # .. event_trigger_repository: openedx/edx-platform
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, dict without annotations
+#      are not serializable.
 FORUM_THREAD_RESPONSE_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.forum.thread.response.created.v1",
     data={
@@ -346,7 +350,8 @@
 # .. event_description: Emitted when a new comment is added to a response.
 # .. event_data: DiscussionThreadData
 # .. event_trigger_repository: openedx/edx-platform
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, dict without annotations
+#      are not serializable.
 FORUM_RESPONSE_COMMENT_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.forum.thread.response.comment.created.v1",
     data={
@@ -360,7 +365,8 @@
 # .. event_description: Emitted when a notification is requested for a course.
 # .. event_data: CourseNotificationData
 # .. event_trigger_repository: openedx/edx-platform
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, dict without annotations
+#      are not serializable.
 COURSE_NOTIFICATION_REQUESTED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.notification.requested.v1",
     data={
@@ -374,7 +380,7 @@
 # .. event_description: Emitted when a user submits an ORA assignment.
 # .. event_data: ORASubmissionData
 # .. event_trigger_repository: openedx/edx-ora2
-# .. event_warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
+# .. event_warning: This event is currently incompatible with the event bus, list[dict] cannot be serialized yet.
 ORA_SUBMISSION_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.ora.submission.created.v1",
     data={