Skip to content

Commit 4cc9739

Browse files
author
Gauvain Pocentek
committed
api-usage: bit more detail for listing with all
1 parent 68b798b commit 4cc9739

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/api-usage.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -228,15 +228,16 @@ parameter to get all the items when using listing methods:
228228
229229
.. warning::
230230

231-
python-gitlab will iterate over the list by calling the corresponding API
232-
multiple times. This might take some time if you have a lot of items to
233-
retrieve. This might also consume a lot of memory as all the items will be
234-
stored in RAM. If you're encountering the python recursion limit exception,
235-
use ``safe_all=True`` instead to stop pagination automatically if the
236-
recursion limit is hit.
237-
238-
With v4, ``list()`` methods can also return a generator object which will
239-
handle the next calls to the API when required:
231+
With API v3 python-gitlab will iterate over the list by calling the
232+
corresponding API multiple times. This might take some time if you have a
233+
lot of items to retrieve. This might also consume a lot of memory as all the
234+
items will be stored in RAM. If you're encountering the python recursion
235+
limit exception, use ``safe_all=True`` to stop pagination automatically if
236+
the recursion limit is hit.
237+
238+
With API v4, ``list()`` methods can also return a generator object which will
239+
handle the next calls to the API when required. This is the recommended way to
240+
iterate through a large number of items:
240241

241242
.. code-block:: python
242243

0 commit comments

Comments
 (0)