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

index bd2d9c1a87d8603bdb5b3aceaa9067595ff72c1f..344247070ffbc5d9025889d6758e836627d0c0f7 100644 (file)
@@ -10,7 +10,11 @@ from tweepy.client import Response
 
 
 class AsyncPaginator:
-    """:class:`AsyncPaginator` can be used to paginate for any
+    """AsyncPaginator( \
+        self, method, *args, limit=inf, pagination_token=None, **kwargs \
+    )
+
+    :class:`AsyncPaginator` can be used to paginate for any
     :class:`AsyncClient` methods that support pagination
 
     .. note::
@@ -28,6 +32,10 @@ class AsyncPaginator:
         :class:`AsyncClient` 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``
     """