Skip to content

Commit e98ab02

Browse files
committed
Document limit and pagination_token parameters for Paginator
1 parent 352c74a commit e98ab02

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

tweepy/pagination.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111

1212
class Paginator:
13-
""":class:`Paginator` can be used to paginate for any :class:`Client`
13+
"""Paginator( \
14+
self, method, *args, limit=inf, pagination_token=None, **kwargs \
15+
)
16+
17+
:class:`Paginator` can be used to paginate for any :class:`Client`
1418
methods that support pagination
1519
1620
.. note::
@@ -28,6 +32,10 @@ class Paginator:
2832
:class:`Client` method to paginate for
2933
args
3034
Positional arguments to pass to ``method``
35+
limit
36+
Maximum number of requests to make to the API
37+
pagination_token
38+
Pagination token to start pagination with
3139
kwargs
3240
Keyword arguments to pass to ``method``
3341
"""

0 commit comments

Comments
 (0)