From 95fcb124ddc40dbbb1353dc995ef0e3aa8330ac4 Mon Sep 17 00:00:00 2001 From: Glib Glugovskiy Date: Mon, 20 Nov 2023 22:39:48 +0200 Subject: [PATCH] docs: add docstring for the paginator property override --- lms/djangoapps/mobile_api/users/views.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lms/djangoapps/mobile_api/users/views.py b/lms/djangoapps/mobile_api/users/views.py index da7b90265e..7a94e00945 100644 --- a/lms/djangoapps/mobile_api/users/views.py +++ b/lms/djangoapps/mobile_api/users/views.py @@ -385,6 +385,11 @@ class UserCourseEnrollmentsList(generics.ListAPIView): # 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')