diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-12-24 14:34:27 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-12-24 14:34:27 +0100 |
| commit | d86ca59dbe1d7f852416ec227a7d241d236424cf (patch) | |
| tree | 4941fbbdfa739bd37378ae640fb122d02fa92045 /docs/api-usage.rst | |
| parent | 15d336256c0dca756e189fb9746ab60be2d3c886 (diff) | |
| download | gitlab-d86ca59dbe1d7f852416ec227a7d241d236424cf.tar.gz | |
[docs] update pagination section
First page is page 1.
Fixes #197
Diffstat (limited to 'docs/api-usage.rst')
| -rw-r--r-- | docs/api-usage.rst | 7 |
1 files changed, 6 insertions, 1 deletions
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: |