summaryrefslogtreecommitdiff
path: root/docs/api-usage.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-02-18 18:17:06 +0000
committerGauvain Pocentek <gauvain@pocentek.net>2016-02-18 18:19:48 +0000
commit453224aaf64c37196b7211de8dd4a60061954987 (patch)
treea77a85c92cc3f50b6ce05345d24fed5c8d76782d /docs/api-usage.rst
parent44d0dc54fb7edf7de4e50ca34d430fe734c0e8cc (diff)
downloadgitlab-453224aaf64c37196b7211de8dd4a60061954987.tar.gz
Re-implement _custom_list in the Gitlab class
Rename the method _raw_list. This adds support for the ``all=True`` option to enable automatic recursion and avoid pagination if requested by the user. Fixes #93
Diffstat (limited to 'docs/api-usage.rst')
-rw-r--r--docs/api-usage.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index b6a498d..ca85fbd 100644
--- a/docs/api-usage.rst
+++ b/docs/api-usage.rst
@@ -112,11 +112,12 @@ You can use pagination to go throught long lists:
ten_first_groups = gl.groups.list(page=0, per_page=10)
-Use the ``all`` parameter to get all the items:
+Use the ``all`` parameter to get all the items when using listing methods:
.. code-block:: python
all_groups = gl.groups.list(all=True)
+ all_owned_projects = gl.projects.owned(all=True)
Sudo
====