summaryrefslogtreecommitdiff
path: root/docs/api-usage.rst
diff options
context:
space:
mode:
authorJohan Brandhorst <johan@cognitivelogic.com>2017-03-23 18:47:03 +0000
committerGauvain Pocentek <gauvain@pocentek.net>2017-03-23 19:47:03 +0100
commit989f3b706d97045f4ea6af69fd11233e2f54adbf (patch)
tree70b97b110e8cd0d79d583b8d1354288d41ef66f0 /docs/api-usage.rst
parent22bf12827387cb1719bacae6c0c745cd768eee6c (diff)
downloadgitlab-989f3b706d97045f4ea6af69fd11233e2f54adbf.tar.gz
Stop listing if recursion limit is hit (#234)
Diffstat (limited to 'docs/api-usage.rst')
-rw-r--r--docs/api-usage.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index a15aecb..7b7ab78 100644
--- a/docs/api-usage.rst
+++ b/docs/api-usage.rst
@@ -142,7 +142,9 @@ parameter to get all the items when using listing methods:
python-gitlab will iterate over the list by calling the correspnding API
multiple times. This might take some time if you have a lot of items to
retrieve. This might also consume a lot of memory as all the items will be
- stored in RAM.
+ stored in RAM. If you're encountering the python recursion limit exception,
+ use ``safe_all=True`` instead to stop pagination automatically if the
+ recursion limit is hit.
Sudo
====