diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-24 01:36:48 +0100 |
|---|---|---|
| committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-24 01:36:48 +0100 |
| commit | 81a392ca6e9b44444c0f1287139abe788d50119d (patch) | |
| tree | 97e0f03be6f8819cb9b8a5dd0d46432ff6dfc5a4 /gitlab/v4/objects/users.py | |
| parent | 7ba5995ed472997e6bf98e8ae58107af307a5615 (diff) | |
| download | gitlab-chore/sphinx-annotations.tar.gz | |
chore: deduplicate type annotations in docschore/sphinx-annotations
Diffstat (limited to 'gitlab/v4/objects/users.py')
| -rw-r--r-- | gitlab/v4/objects/users.py | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py index 8649cba..fac448a 100644 --- a/gitlab/v4/objects/users.py +++ b/gitlab/v4/objects/users.py @@ -167,7 +167,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabBlockError: If the user could not be blocked Returns: - bool: Whether the user status has been changed + Whether the user status has been changed """ path = f"/users/{self.id}/block" server_data = self.manager.gitlab.http_post(path, **kwargs) @@ -188,7 +188,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabFollowError: If the user could not be followed Returns: - dict: The new object data (*not* a RESTObject) + The new object data (*not* a RESTObject) """ path = f"/users/{self.id}/follow" return self.manager.gitlab.http_post(path, **kwargs) @@ -206,7 +206,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabUnfollowError: If the user could not be followed Returns: - dict: The new object data (*not* a RESTObject) + The new object data (*not* a RESTObject) """ path = f"/users/{self.id}/unfollow" return self.manager.gitlab.http_post(path, **kwargs) @@ -224,7 +224,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabUnblockError: If the user could not be unblocked Returns: - bool: Whether the user status has been changed + Whether the user status has been changed """ path = f"/users/{self.id}/unblock" server_data = self.manager.gitlab.http_post(path, **kwargs) @@ -245,7 +245,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabDeactivateError: If the user could not be deactivated Returns: - bool: Whether the user status has been changed + Whether the user status has been changed """ path = f"/users/{self.id}/deactivate" server_data = self.manager.gitlab.http_post(path, **kwargs) @@ -266,7 +266,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabActivateError: If the user could not be activated Returns: - bool: Whether the user status has been changed + Whether the user status has been changed """ path = f"/users/{self.id}/activate" server_data = self.manager.gitlab.http_post(path, **kwargs) @@ -520,15 +520,15 @@ class UserProjectManager(ListMixin, CreateMixin, RESTManager): """Retrieve a list of objects. 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) Returns: - list: The list of objects, or a generator if `as_list` is False + The list of objects, or a generator if `as_list` is False Raises: GitlabAuthenticationError: If authentication is not correct |