From d86ca59dbe1d7f852416ec227a7d241d236424cf Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sat, 24 Dec 2016 14:34:27 +0100 Subject: [docs] update pagination section First page is page 1. Fixes #197 --- docs/api-usage.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'docs/api-usage.rst') diff --git a/docs/api-usage.rst b/docs/api-usage.rst index b33913d..4f8cb37 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -111,7 +111,12 @@ listing methods support the ``page`` and ``per_page`` parameters: .. code-block:: python - ten_first_groups = gl.groups.list(page=0, per_page=10) + ten_first_groups = gl.groups.list(page=1, per_page=10) + +.. note:: + + The first page is page 1, not page 0. + By default GitLab does not return the complete list of items. Use the ``all`` parameter to get all the items when using listing methods: -- cgit v1.2.1