Document limit and pagination_token parameters for Paginator
authorHarmon <Harmon758@gmail.com>
Sun, 30 Oct 2022 03:24:13 +0000 (22:24 -0500)
committerHarmon <Harmon758@gmail.com>
Sun, 30 Oct 2022 03:24:13 +0000 (22:24 -0500)
tweepy/pagination.py

index b30c9e669deae3870bce71bde63ea80e2aa15109..004d22ce9c1c4ec0113b19547b684b317063b8ca 100644 (file)
@@ -10,7 +10,11 @@ from tweepy.client import Response
 
 
 class Paginator:
-    """:class:`Paginator` can be used to paginate for any :class:`Client`
+    """Paginator( \
+        self, method, *args, limit=inf, pagination_token=None, **kwargs \
+    )
+
+    :class:`Paginator` can be used to paginate for any :class:`Client`
     methods that support pagination
 
     .. note::
@@ -28,6 +32,10 @@ class Paginator:
         :class:`Client` method to paginate for
     args
         Positional arguments to pass to ``method``
+    limit
+        Maximum number of requests to make to the API
+    pagination_token
+        Pagination token to start pagination with
     kwargs
         Keyword arguments to pass to ``method``
     """