Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve PaginatedList docs #654

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading