mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-19 17:01:25 -07:00
[PR #9395/3048d530 backport][stable-9] g*.py: normalize docs (#9414)
g*.py: normalize docs (#9395)
* 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>
(cherry picked from commit 3048d5305d
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
87d63c5bed
commit
a66b9fc5c9
36 changed files with 633 additions and 683 deletions
|
@ -12,7 +12,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r"""
|
||||
module: gitlab_merge_request
|
||||
short_description: Create, update, or delete GitLab merge requests
|
||||
version_added: 7.1.0
|
||||
|
@ -21,8 +21,7 @@ description:
|
|||
- When a single merge request does exist, it will be updated if the provided parameters are different.
|
||||
- When a single merge request does exist and O(state=absent), the merge request will be deleted.
|
||||
- When multiple merge requests are detected, the task fails.
|
||||
- Existing merge requests are matched based on O(title), O(source_branch), O(target_branch),
|
||||
and O(state_filter) filters.
|
||||
- Existing merge requests are matched based on O(title), O(source_branch), O(target_branch), and O(state_filter) filters.
|
||||
author:
|
||||
- zvaraondrej (@zvaraondrej)
|
||||
requirements:
|
||||
|
@ -102,10 +101,10 @@ options:
|
|||
- Comma separated list of reviewers usernames omitting V(@) character.
|
||||
- Set to empty string to unassign all reviewers.
|
||||
type: str
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create Merge Request from branch1 to branch2
|
||||
community.general.gitlab_merge_request:
|
||||
api_url: https://gitlab.com
|
||||
|
@ -117,7 +116,7 @@ EXAMPLES = '''
|
|||
description: "Demo MR description"
|
||||
labels: "Ansible,Demo"
|
||||
state_filter: "opened"
|
||||
remove_source_branch: True
|
||||
remove_source_branch: true
|
||||
state: present
|
||||
|
||||
- name: Delete Merge Request from branch1 to branch2
|
||||
|
@ -130,9 +129,9 @@ EXAMPLES = '''
|
|||
title: "Ansible demo MR"
|
||||
state_filter: "opened"
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Success or failure message.
|
||||
returned: always
|
||||
|
@ -143,7 +142,7 @@ mr:
|
|||
description: API object.
|
||||
returned: success
|
||||
type: dict
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.api import basic_auth_argument_spec
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue