diff options
Diffstat (limited to 'gitlab/v4/objects/milestones.py')
| -rw-r--r-- | gitlab/v4/objects/milestones.py | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/gitlab/v4/objects/milestones.py b/gitlab/v4/objects/milestones.py index 8ba9d61..a1e48a5 100644 --- a/gitlab/v4/objects/milestones.py +++ b/gitlab/v4/objects/milestones.py @@ -30,10 +30,10 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): """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 + all: If True, return all the items, without pagination + per_page: Number of items to retrieve per request + page: ID of the page to return (starts with page 1) + as_list: 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) @@ -42,7 +42,7 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabListError: If the list could not be retrieved Returns: - RESTObjectList: The list of issues + The list of issues """ path = f"{self.manager.path}/{self.get_id()}/issues" @@ -59,10 +59,10 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): """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 + all: If True, return all the items, without pagination + per_page: Number of items to retrieve per request + page: ID of the page to return (starts with page 1) + as_list: 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) @@ -71,7 +71,7 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabListError: If the list could not be retrieved Returns: - RESTObjectList: The list of merge requests + The list of merge requests """ path = f"{self.manager.path}/{self.get_id()}/merge_requests" data_list = self.manager.gitlab.http_list(path, as_list=False, **kwargs) @@ -111,10 +111,10 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): """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 + all: If True, return all the items, without pagination + per_page: Number of items to retrieve per request + page: ID of the page to return (starts with page 1) + as_list: 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) @@ -123,7 +123,7 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): GitlabListError: If the list could not be retrieved Returns: - RESTObjectList: The list of issues + The list of issues """ path = f"{self.manager.path}/{self.get_id()}/issues" @@ -140,10 +140,10 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): """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 + all: If True, return all the items, without pagination + per_page: Number of items to retrieve per request + page: ID of the page to return (starts with page 1) + as_list: 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) @@ -152,7 +152,7 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): GitlabListError: If the list could not be retrieved Returns: - RESTObjectList: The list of merge requests + The list of merge requests """ path = f"{self.manager.path}/{self.get_id()}/merge_requests" data_list = self.manager.gitlab.http_list(path, as_list=False, **kwargs) |