docs: update example usage in docstrings

openedx · May 12, 2021 · 3e6004e · 3e6004e
1 parent b18f6df
commit 3e6004e
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/openedx_filters/lms/auth/v1/login.py b/openedx_filters/lms/auth/v1/login.py
@@ -34,6 +34,7 @@ def before_creation(user, *args, **kwargs):
     has not been logged in yet.
 
     Example usage:
+        To be provided.
 
     Arguments:
         - user (User): Django User object associated with the

diff --git a/openedx_filters/lms/auth/v1/registration.py b/openedx_filters/lms/auth/v1/registration.py
@@ -34,6 +34,7 @@ def before_creation(data, *args, **kwargs):
     been registered yet.
 
     Example usage:
+        To be provided.
 
     Arguments:
         - data (querydict): data from the registration form filled by the

diff --git a/openedx_filters/lms/enrollment/v1/enrollment.py b/openedx_filters/lms/enrollment/v1/enrollment.py
@@ -34,6 +34,7 @@ def before_creation(user, course_key, *args, **kwargs):
     been enrolled in the course yet.
 
     Example usage:
+        To be provided.
 
     Arguments:
         - user (User): Django User object to be enrolled in the course.
@@ -64,6 +65,7 @@ def before_deactivation(enrollment, *args, **kwargs):
     been un-enrolled from the course yet.
 
     Example usage:
+        To be provided.
 
     Arguments:
         - enrollment (CourseEnrollment): user's Enrollment record for