Document the global per_page setting

Gauvain Pocentek · Gauvain Pocentek · commit 660f0cf546d1 · 2018-05-26T08:21:45.000+02:00
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -189,6 +189,13 @@ parameter to get all the items when using listing methods:
    all_groups = gl.groups.list(all=True)
    all_owned_projects = gl.projects.owned(all=True)
 
+You can define the ``per_page`` value globally to avoid passing it to every
+``list()`` method call:
+
+.. code-block:: python
+
+   gl = gitlab.Gitlab(url, token, per_page=50)
+
 ``list()`` methods can also return a generator object which will handle the
 next calls to the API when required. This is the recommended way to iterate
 through a large number of items:
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -71,6 +71,10 @@ parameters. You can override the values in each GitLab server section.
    * - ``api_version``
      - ``3`` ou ``4``
      - The API version to use to make queries. Requires python-gitlab >= 1.3.0.
+   * - ``per_page``
+     - Integer between 1 and 100
+     - The number of items to return in listing queries. GitLab limits the
+       value at 100.
 
 You must define the ``url`` in each GitLab server section.
 
