Document api.cursor's return_pages kwarg #465

Merged
clayadavis merged 2 commits from docs into master 2017-10-19 10:43:05 -07:00

View file

@ -45,10 +45,23 @@ Another example:
.. code-block:: python .. code-block:: python
results = twitter.cursor(t.get_mentions_timeline) results = twitter.cursor(twitter.get_mentions_timeline)
for result in results: for result in results:
print(result['id_str']) print(result['id_str'])
Items vs Pages
^^^^^^^^^^^^^^
By default, the cursor yields one item at a time. If instead you prefer to work with entire pages of results, specify ``return_pages=True`` as a keyword argument.
.. code-block:: python
results = twitter.cursor(twitter.get_mentions_timeline, return_pages=True)
# page is a list
for page in results:
for result in page:
print(result['id_str'])
HTML for Tweet HTML for Tweet
-------------- --------------