docs: add docstring for the paginator property override

nelc · Nov 20, 2023 · 95fcb12 · 95fcb12
1 parent ee4b92c
commit 95fcb12
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lms/djangoapps/mobile_api/users/views.py b/lms/djangoapps/mobile_api/users/views.py
@@ -385,6 +385,11 @@ def list(self, request, *args, **kwargs):
     # pylint: disable=attribute-defined-outside-init
     @property
     def paginator(self):
+        """
+        Overrides API View paginator property to dynamically determine pagination class 
+        based on the provided api_version. Implements solutions from the discussion at 
+        https://www.github.com/encode/django-rest-framework/issues/6397.
+        """
         super().paginator  # pylint: disable=expression-not-assigned
         api_version = self.kwargs.get('api_version')