docs: update inline code annotations following reviews

openedx · Jul 28, 2021 · 367d7d1 · 367d7d1
1 parent 931db62
commit 367d7d1
Showing 1 changed file with 45 additions and 70 deletions.
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -11,14 +11,11 @@
 from openedx_events.learning.data import CertificateData, CohortData, CourseEnrollmentData, UserData
 from openedx_events.tooling import OpenEdxPublicSignal
 
-# ..event_type: org.openedx.learning.student.registration.completed.v1
-# ..event_name: STUDENT_REGISTRATION_COMPLETED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user registration process in the LMS
-# is completed.
-# ..event_data: UserData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.student.registration.completed.v1
+# .. event_name: STUDENT_REGISTRATION_COMPLETED
+# .. event_description: emitted when the user registration process in the LMS is completed.
+# .. event_data: UserData
+# .. event_creation_date: 2020-22-07
 STUDENT_REGISTRATION_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.student.registration.completed.v1",
     data={
@@ -27,14 +24,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.auth.session.login.completed.v1
-# ..event_name: SESSION_LOGIN_COMPLETED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's login process in the LMS is
-# completed.
-# ..event_data: UserData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.auth.session.login.completed.v1
+# .. event_name: SESSION_LOGIN_COMPLETED
+# .. event_description: emitted when the user's login process in the LMS is completed.
+# .. event_data: UserData
+# .. event_creation_date: 2020-22-07
 SESSION_LOGIN_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.auth.session.login.completed.v1",
     data={
@@ -43,13 +37,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.course.enrollment.created.v1
-# ..event_name: COURSE_ENROLLMENT_CREATED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's enrollment process is completed.
-# ..event_data: CourseEnrollmentData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.course.enrollment.created.v1
+# .. event_name: COURSE_ENROLLMENT_CREATED
+# .. event_description: emitted when the user's enrollment process is completed.
+# .. event_data: CourseEnrollmentData
+# .. event_creation_date: 2020-22-07
 COURSE_ENROLLMENT_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.enrollment.created.v1",
     data={
@@ -58,14 +50,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.course.enrollment.changed.v1
-# ..event_name: COURSE_ENROLLMENT_CHANGED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's enrollment update process is
-# completed.
-# ..event_data: CourseEnrollmentData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.course.enrollment.changed.v1
+# .. event_name: COURSE_ENROLLMENT_CHANGED
+# .. event_description: emitted when the user's enrollment update process is completed.
+# .. event_data: CourseEnrollmentData
+# .. event_creation_date: 2020-22-07
 COURSE_ENROLLMENT_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.enrollment.changed.v1",
     data={
@@ -74,14 +63,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.course.unenrollment.completed.v1
-# ..event_name: COURSE_ENROLLMENT_CHANGED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's unenrollment process is
-# completed.
-# ..event_data: CourseEnrollmentData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.course.unenrollment.completed.v1
+# .. event_name: COURSE_ENROLLMENT_CHANGED
+# .. event_description: emitted when the user's unenrollment process is completed.
+# .. event_data: CourseEnrollmentData
+# .. event_creation_date: 2020-22-07
 COURSE_UNENROLLMENT_COMPLETED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.course.unenrollment.completed.v1",
     data={
@@ -90,14 +76,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.certificate.created.v1
-# ..event_name: CERTIFICATE_CREATED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's certificate creation process is
-# completed.
-# ..event_data: CertificateData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.certificate.created.v1
+# .. event_name: CERTIFICATE_CREATED
+# .. event_description: emitted when the user's certificate creation process is completed.
+# .. event_data: CertificateData
+# .. event_creation_date: 2020-22-07
 CERTIFICATE_CREATED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.created.v1",
     data={
@@ -106,14 +89,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.certificate.created.v1
-# ..event_name: CERTIFICATE_CREATED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's certificate creation process is
-# completed.
-# ..event_data: CertificateData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.certificate.created.v1
+# .. event_name: CERTIFICATE_CREATED
+# .. event_description: emitted when the user's certificate creation process is completed.
+# .. event_data: CertificateData
+# .. event_creation_date: 2020-22-07
 CERTIFICATE_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.changed.v1",
     data={
@@ -122,14 +102,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.certificate.revoked.v1
-# ..event_name: CERTIFICATE_REVOKED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's certificate annulation process
-# is completed.
-# ..event_data: CertificateData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.certificate.revoked.v1
+# .. event_name: CERTIFICATE_REVOKED
+# .. event_description: emitted when the user's certificate annulation process is completed.
+# .. event_data: CertificateData
+# .. event_creation_date: 2020-22-07
 CERTIFICATE_REVOKED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.certificate.revoked.v1",
     data={
@@ -138,13 +115,11 @@
 )
 
 
-# ..event_type: org.openedx.learning.cohort_membership.changed.v1
-# ..event_name: COHORT_MEMBERSHIP_CHANGED
-# ..event_version: V1
-# ..event_implementation: OpenEdxPublicSignal(DjangoSignal)
-# ..event_description: emitted when the user's cohort update is completed.
-# ..event_data: CohortData
-# ..event_creation_date: 2020-22-07
+# .. event_type: org.openedx.learning.cohort_membership.changed.v1
+# .. event_name: COHORT_MEMBERSHIP_CHANGED
+# .. event_description: emitted when the user's cohort update is completed.
+# .. event_data: CohortData
+# .. event_creation_date: 2020-22-07
 COHORT_MEMBERSHIP_CHANGED = OpenEdxPublicSignal(
     event_type="org.openedx.learning.cohort_membership.changed.v1",
     data={