ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

g*.py: normalize docs (#9395)

Browse source 
* g*.py: normalize docs

* Update plugins/modules/gandi_livedns.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-27 09:54:03 +13:00 • committed by GitHub
parent df42f29e53
commit 3048d5305d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 633 additions and 683 deletions
Download patch file Download diff file Expand all files Collapse all files

24
plugins/modules/gitlab_label.py
View file

@ -7,9 +7,9 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r"""
module: gitlab_label
short_description: Creates/updates/deletes GitLab Labels belonging to project or group.
short_description: Creates/updates/deletes GitLab Labels belonging to project or group
version_added: 8.3.0
description:
- When a label does not exist, it will be created.
@ -45,12 +45,12 @@ options:
required: false
project:
description:
- The path and name of the project. Either this or O(group) is required.
- The path and name of the project. Either this or O(group) is required.
required: false
type: str
group:
description:
- The path of the group. Either this or O(project) is required.
- The path of the group. Either this or O(project) is required.
required: false
type: str
labels:
@ -76,21 +76,21 @@ options:
- Integer value to give priority to the label.
type: int
required: false
default: null
default:
description:
description:
- Label's description.
type: str
default: null
default:
new_name:
description:
- Optional field to change label's name.
type: str
default: null
'''
default:
"""
EXAMPLES = '''
EXAMPLES = r"""
# same project's task can be executed for group
- name: Create one Label
community.general.gitlab_label:
@ -185,9 +185,9 @@ EXAMPLES = '''
labels:
- name: label-abc123
- name: label-two
'''
"""
RETURN = '''
RETURN = r"""
labels:
description: Four lists of the labels which were added, updated, removed or exist.
returned: success
@ -217,7 +217,7 @@ labels_obj:
description: API object.
returned: success
type: dict
'''
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.api import basic_auth_argument_spec