diff options
| -rw-r--r-- | gitlab/__init__.py | 14 | ||||
| -rw-r--r-- | gitlab/mixins.py | 14 | ||||
| -rw-r--r-- | gitlab/v4/objects.py | 36 |
3 files changed, 32 insertions, 32 deletions
diff --git a/gitlab/__init__.py b/gitlab/__init__.py index 8e62188..dcbf6b7 100644 --- a/gitlab/__init__.py +++ b/gitlab/__init__.py @@ -407,7 +407,7 @@ class Gitlab(object): json) streamed (bool): Whether the data should be streamed files (dict): The files to send to the server - **kwargs: Extra data to make the query (e.g. sudo, per_page, page) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: A requests result object. @@ -502,7 +502,7 @@ class Gitlab(object): 'http://whatever/v4/api/projecs') query_data (dict): Data to send as query parameters streamed (bool): Whether the data should be streamed - **kwargs: Extra data to make the query (e.g. sudo, per_page, page) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: A requests result object is streamed is True or the content type is @@ -532,8 +532,8 @@ class Gitlab(object): path (str): Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') query_data (dict): Data to send as query parameters - **kwargs: Extra data to make the query (e.g. sudo, per_page, page, - all) + **kwargs: Extra options to send to the server (e.g. sudo, page, + per_page) Returns: list: A list of the objects returned by the server. If `as_list` is @@ -575,7 +575,7 @@ class Gitlab(object): post_data (dict): Data to send in the body (will be converted to json) files (dict): The files to send to the server - **kwargs: Extra data to make the query (e.g. sudo, per_page, page) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: The parsed json returned by the server if json is return, else the @@ -606,7 +606,7 @@ class Gitlab(object): post_data (dict): Data to send in the body (will be converted to json) files (dict): The files to send to the server - **kwargs: Extra data to make the query (e.g. sudo, per_page, page) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: The parsed json returned by the server. @@ -629,7 +629,7 @@ class Gitlab(object): Args: path (str): Path or full URL to query ('/projects' or 'http://whatever/v4/api/projecs') - **kwargs: Extra data to make the query (e.g. sudo, per_page, page) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: The requests object. diff --git a/gitlab/mixins.py b/gitlab/mixins.py index bd4d8c7..2c80f36 100644 --- a/gitlab/mixins.py +++ b/gitlab/mixins.py @@ -32,7 +32,7 @@ class GetMixin(object): lazy (bool): If True, don't request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API. - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: object: The generated RESTObject. @@ -56,7 +56,7 @@ class GetWithoutIdMixin(object): """Retrieve a single object. Args: - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: object: The generated RESTObject @@ -77,7 +77,7 @@ class RefreshMixin(object): """Refresh a single object from server. Args: - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns None (updates the object) @@ -104,7 +104,7 @@ class ListMixin(object): 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 Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: list: The list of objects, or a generator if `as_list` is False @@ -168,7 +168,7 @@ class CreateMixin(object): Args: data (dict): parameters to send to the server to create the resource - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: RESTObject: a new instance of the managed object class built with @@ -244,7 +244,7 @@ class UpdateMixin(object): Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: dict: The new object data (*not* a RESTObject) @@ -313,7 +313,7 @@ class DeleteMixin(object): Args: id: ID of the object to delete - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index 3e16bac..6650fc0 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -227,7 +227,7 @@ class UserProjectManager(ListMixin, CreateMixin, RESTManager): 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 Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: list: The list of objects, or a generator if `as_list` is False @@ -430,7 +430,7 @@ class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager): Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: dict: The new object data (*not* a RESTObject) @@ -642,7 +642,7 @@ class GroupEpicIssueManager(ListMixin, CreateMixin, UpdateMixin, DeleteMixin, Args: data (dict): Parameters to send to the server to create the resource - **kwargs: Extra data to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -896,7 +896,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject): group_access (int): Minimum access level for members of the LDAP group provider (str): LDAP provider for the LDAP group - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -914,7 +914,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject): Args: cn (str): CN of the LDAP group provider (str): LDAP provider for the LDAP group - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -932,7 +932,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject): """Sync LDAP groups. Args: - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -1004,7 +1004,7 @@ class LDAPGroupManager(RESTManager): 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 Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: list: The list of objects, or a generator if `as_list` is False @@ -1387,8 +1387,8 @@ class ProjectCommitStatusManager(ListMixin, CreateMixin, RESTManager): Args: data (dict): Parameters to send to the server to create the resource - **kwargs: Extra data to send to the Gitlab server (e.g. sudo or - 'ref_name', 'stage', 'name', 'all'. + **kwargs: Extra options to send to the server (e.g. sudo or + 'ref_name', 'stage', 'name', 'all') Raises: GitlabAuthenticationError: If authentication is not correct @@ -1736,7 +1736,7 @@ class ProjectIssueLinkManager(ListMixin, CreateMixin, DeleteMixin, Args: data (dict): parameters to send to the server to create the resource - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: RESTObject, RESTObject: The source and target issues @@ -2303,7 +2303,7 @@ class ProjectLabelManager(ListMixin, CreateMixin, UpdateMixin, DeleteMixin, Args: name: The name of the label - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -2376,7 +2376,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, Args: file_path (str): Path of the file to retrieve ref (str): Name of the branch, tag or commit - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -2399,7 +2399,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, Args: data (dict): parameters to send to the server to create the resource - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: RESTObject: a new instance of the managed object class built with @@ -2424,7 +2424,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: dict: The new object data (*not* a RESTObject) @@ -2451,7 +2451,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, file_path (str): Path of the file to remove branch (str): Branch from which the file will be removed commit_message (str): Commit message for the deletion - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -2476,7 +2476,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, action (callable): Callable responsible of dealing with chunk of data chunk_size (int): Size of each chunk - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Raises: GitlabAuthenticationError: If authentication is not correct @@ -2849,7 +2849,7 @@ class ProjectServiceManager(GetMixin, UpdateMixin, DeleteMixin, RESTManager): lazy (bool): If True, don't request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API. - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: object: The generated RESTObject. @@ -2868,7 +2868,7 @@ class ProjectServiceManager(GetMixin, UpdateMixin, DeleteMixin, RESTManager): Args: id: ID of the object to update (can be None if not required) new_data: the update data for the object - **kwargs: Extra options to send to the Gitlab server (e.g. sudo) + **kwargs: Extra options to send to the server (e.g. sudo) Returns: dict: The new object data (*not* a RESTObject) |