some more documentation about iterators

odrling · Jun 28, 2017 · c736ccb · c736ccb
1 parent 3029d6d
commit c736ccb
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 19 deletions.
diff --git a/docs/usage/iterators.rst b/docs/usage/iterators.rst
@@ -102,3 +102,9 @@ An iterator for endpoints using the ``since_id`` parameter
     .. code-block:: python
 
         responses = request.iterator.with_since_id(fill_gaps=True)
+
+.. note::
+    Both :func:`~peony.iterators.with_since_id` and
+    :func:`~peony.iterators.with_max_id` have a ``force`` parameter that can
+    be used in case you need to keep making requests after a request returned
+    no content. Set ``force`` to ``True`` if this is the case.
diff --git a/peony/iterators.py b/peony/iterators.py
@@ -9,10 +9,8 @@ class AbstractIterator(ABC):
 
     Parameters
     ----------
-    _request : .requests.Request
+    request : .requests.Request
         Main request
-    **kwargs : dict
-        Parameters of the request
     """
 
     def __init__(self, request):
@@ -35,14 +33,12 @@ class IdIterator(AbstractIterator):
 
     Parameters
     ----------
-    _request : .requests.Request
+    request : .requests.Request
         Main request
-    _parameter : str
+    parameter : str
         Parameter to change for each request
-    _force : bool
+    force : bool
         Keep the iterator after empty responses
-    kwargs : dict
-        Request parameters
     """
 
     def __init__(self, request, parameter, force=False):
@@ -73,10 +69,8 @@ class MaxIdIterator(IdIterator):
 
     Parameters
     ----------
-    _request : .requests.Request
+    request : .requests.Request
         Main request
-    kwargs : dict
-        Parameters of the request
     """
 
     def __init__(self, request):
@@ -98,14 +92,12 @@ class SinceIdIterator(IdIterator):
 
     Parameters
     ----------
-    _request : .requests.Request
+    request : .requests.Request
         Main request
-    _force : bool
+    force : bool
         Keep the iterator after empty responses
-    _fill_gaps : bool
+    fill_gaps : bool
         Fill the gaps (if there are more than ``count`` tweets to get)
-    **kwargs : dict
-        Parameters of the request
     """
 
     def __init__(self, request, force=True, fill_gaps=False):
@@ -162,10 +154,8 @@ class CursorIterator(AbstractIterator):
 
     Parameters
     ----------
-    _request : .requests.Request
+    request : .requests.Request
         Main request
-    **kwargs : dict
-        Parameters of the request
     """
 
     async def __anext__(self):