code/twython
1
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Merge pull request #465 from clayadavis/docs

Browse source 
Document api.cursor's return_pages kwarg
This commit is contained in:
Mike Helmick 2017-10-19 13:43:05 -04:00 • committed by GitHub
commit 3f5de4ad89
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/usage/special_functions.rst
View file

@ -45,10 +45,23 @@ Another example:
.. code-block:: python
results = twitter.cursor(t.get_mentions_timeline)
results = twitter.cursor(twitter.get_mentions_timeline)
for result in results:
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
--------------