From c1e8556105e3d888db24c3ed4027f762e28316b5 Mon Sep 17 00:00:00 2001 From: Brian Date: Sat, 11 May 2024 22:29:48 -0400 Subject: [PATCH] Improve `PaginatedList` docs (#654) * Improve `PaginatedList` docstring Include details for each parameter used in PaginatedList. * Improve `PaginatedList` docstring Include details for each parameter used in PaginatedList. * Remove class docstring addition --------- Co-authored-by: Matthew Emond --- canvasapi/paginated_list.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/canvasapi/paginated_list.py b/canvasapi/paginated_list.py index 9decf747..0183f93d 100644 --- a/canvasapi/paginated_list.py +++ b/canvasapi/paginated_list.py @@ -28,6 +28,24 @@ def __init__( _url_override=None, **kwargs ): + """ + :param content_class: The expected type to return in the list. + :type content_class: class + :param requester: The requester to pass HTTP requests through. + :type requester: :class:`canvasapi.requester.Requester` + :param request_method: HTTP request method + :type request_method: str + :param first_url: Canvas endpoint for the initial request + :type first_url: str + :param extra_attribs: Extra data to include in the request + :type extra_attribs: dict + :param _root: Specify a nested property from Canvas to use for the resulting list. + :type _root: str + :param _url_override: "new_quizzes" or "graphql" for specific Canvas endpoints. + Other URLs may be specified for third-party requests. + :type _url_override: str + :rtype: :class:`canvasapi.paginated_list.PaginatedList` of type content_class + """ self._elements = list() self._requester = requester