docs: try new inline code doc

openedx · Jul 22, 2021 · 90893b4 · 90893b4
1 parent c0fd9bc
commit 90893b4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -16,6 +16,13 @@
 )
 from openedx_events.tooling import OpenEdxPublicSignal
 
+# ..event_type: org.openedx.learning.student.registration.completed.v1
+# ..event_name: STUDENT_REGISTRATION_COMPLETED
+# ..event_description: emitted when the user registration process is completed.
+# ..event_data: UserData
+# ..event_use_cases:
+# ..event_creation_date: None
+# ..event_tickets: not sure about this one
 STUDENT_REGISTRATION_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.student.registration.completed.v1",
     data={