Skip to content

Commit

Permalink
Improve PaginatedList docs (#654)
Browse files Browse the repository at this point in the history
* 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 <me@ucf.edu>
  • Loading branch information
bennettscience and Thetwam authored May 12, 2024
1 parent 1196b01 commit c1e8556
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions canvasapi/paginated_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c1e8556

Please sign in to comment.