Skip to content

Commit

Permalink
Clarify pagination API, add page_size
Browse files Browse the repository at this point in the history
  • Loading branch information
yakky committed Dec 30, 2017
1 parent 7a57741 commit 23b9857
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ You can also specify filters
tasks = api.tasks.list(project=1)
By defaults list returns all objects, eventually getting the
By default list returns all objects, eventually getting the
paginated results behind the scenes.

If you want to disable pagination support and get all the
Expand All @@ -190,6 +190,12 @@ argument and the page number
tasks_page_1 = api.tasks.list(lazy_pagination) # Will only return page 1
tasks_page_2 = api.tasks.list(lazy_pagination, page=2) # Will return page 2
Page size (default: 100) can be passed as an argument

tasks_page_1 = api.tasks.list(lazy_pagination, page_size=200) # Will return 200 results from page 2

.. code:: python
Attach a file
~~~~~~~~~~~~~

Expand Down

0 comments on commit 23b9857

Please sign in to comment.