Update pagination docs for ProjectCommit

In v3 pagination starts at page 0 instead of page 1. Fixes: #377
python-gitlab · Dec 11, 2017 · c6c0686 · c6c0686
1 parent 084b905
commit c6c0686
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -203,7 +203,7 @@ listing methods support the ``page`` and ``per_page`` parameters:
 
 .. note::
 
-   The first page is page 1, not page 0.
+   The first page is page 1, not page 0, except for project commits in v3 API.
 
 By default GitLab does not return the complete list of items. Use the ``all``
 parameter to get all the items when using listing methods:

diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst
@@ -23,6 +23,11 @@ Reference
 
 * GitLab API: https://docs.gitlab.com/ce/api/commits.html
 
+.. warning::
+
+   Pagination starts at page 0 in v3, but starts at page 1 in v4 (like all the
+   v4 endpoints).
+
 
 Examples
 --------