Skip to content

Commit d86ca59

Browse files
author
Gauvain Pocentek
committed
[docs] update pagination section
First page is page 1. Fixes python-gitlab#197
1 parent 15d3362 commit d86ca59

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/api-usage.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,12 @@ listing methods support the ``page`` and ``per_page`` parameters:
111111

112112
.. code-block:: python
113113
114-
ten_first_groups = gl.groups.list(page=0, per_page=10)
114+
ten_first_groups = gl.groups.list(page=1, per_page=10)
115+
116+
.. note::
117+
118+
The first page is page 1, not page 0.
119+
115120

116121
By default GitLab does not return the complete list of items. Use the ``all``
117122
parameter to get all the items when using listing methods:

0 commit comments

Comments
 (0)