[docstrings] Explicitly documentation pagination arguments

Gauvain Pocentek · Gauvain Pocentek · commit b0ce3c80757f · 2017-12-16T08:04:32.000+01:00
Fixes #393
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -470,6 +470,11 @@ def issues(self, **kwargs):
         """List issues related to this milestone.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -494,6 +499,11 @@ def merge_requests(self, **kwargs):
         """List the merge requests related to this milestone.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -1353,6 +1363,11 @@ def closes_issues(self, **kwargs):
         """List issues that will close on merge."
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -1375,6 +1390,11 @@ def commits(self, **kwargs):
         """List the merge request commits.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -1477,6 +1497,11 @@ def issues(self, **kwargs):
         """List issues related to this milestone.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -1501,6 +1526,11 @@ def merge_requests(self, **kwargs):
         """List the merge requests related to this milestone.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -2135,6 +2165,11 @@ def repository_tree(self, path='', ref='', **kwargs):
         Args:
             path (str): Path of the top folder (/ by default)
             ref (str): Reference to a commit or branch
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -2229,6 +2264,11 @@ def repository_contributors(self, **kwargs):
         """Return a list of contributors for the project.
 
         Args:
+            all (bool): If True, return all the items, without pagination
+            per_page (int): Number of items to retrieve per request
+            page (int): ID of the page to return (starts with page 1)
+            as_list (bool): If set to False and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
