summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/groups.py
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-11-24 20:52:28 +0100
committerNejc Habjan <hab.nejc@gmail.com>2021-11-28 18:31:59 +0100
commitb7dde0d7aac8dbaa4f47f9bfb03fdcf1f0b01c41 (patch)
treeddf38afd58c7f1dcd538667dd952122448289bb6 /gitlab/v4/objects/groups.py
parentbd366ab9e4b552fb29f7a41564cc180a659bba2f (diff)
downloadgitlab-b7dde0d7aac8dbaa4f47f9bfb03fdcf1f0b01c41.tar.gz
docs: only use type annotations for documentation
Diffstat (limited to 'gitlab/v4/objects/groups.py')
-rw-r--r--gitlab/v4/objects/groups.py28
1 files changed, 14 insertions, 14 deletions
diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py
index 7016e52..33b5c59 100644
--- a/gitlab/v4/objects/groups.py
+++ b/gitlab/v4/objects/groups.py
@@ -83,7 +83,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Transfer a project to this group.
Args:
- to_project_id (int): ID of the project to transfer
+ to_project_id: ID of the project to transfer
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -101,8 +101,8 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Search the group resources matching the provided string.'
Args:
- scope (str): Scope of the search
- search (str): Search string
+ scope: Scope of the search
+ search: Search string
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -124,10 +124,10 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Add an LDAP group link.
Args:
- cn (str): CN of the LDAP group
- group_access (int): Minimum access level for members of the LDAP
+ cn: CN of the LDAP group
+ group_access: Minimum access level for members of the LDAP
group
- provider (str): LDAP provider for the LDAP group
+ provider: LDAP provider for the LDAP group
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -146,8 +146,8 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Delete an LDAP group link.
Args:
- cn (str): CN of the LDAP group
- provider (str): LDAP provider for the LDAP group
+ cn: CN of the LDAP group
+ provider: LDAP provider for the LDAP group
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -187,8 +187,8 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Share the group with a group.
Args:
- group_id (int): ID of the group.
- group_access (int): Access level for the group.
+ group_id: ID of the group.
+ group_access: Access level for the group.
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -215,7 +215,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
"""Delete a shared group link within a group.
Args:
- group_id (int): ID of the group.
+ group_id: ID of the group.
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
@@ -308,9 +308,9 @@ class GroupManager(CRUDMixin, RESTManager):
Args:
file: Data or file object containing the group
- path (str): The path for the new group to be imported.
- name (str): The name for the new group.
- parent_id (str): ID of a parent group that the group will
+ path: The path for the new group to be imported.
+ name: The name for the new group.
+ parent_id: ID of a parent group that the group will
be imported into.
**kwargs: Extra options to send to the server (e.g. sudo)