[PR #9395/3048d530 backport][stable-10] g*.py: normalize docs (#9415)

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:
patchback[bot] 2024-12-26 22:44:20 +01:00 committed by GitHub
parent 0e99b006a2
commit 1829ad4fdc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 633 additions and 683 deletions

View file

@ -11,11 +11,11 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r"""
module: gitlab_deploy_key
short_description: Manages GitLab project deploy keys
description:
- Adds, updates and removes project deploy keys
- Adds, updates and removes project deploy keys.
author:
- Marcus Watkins (@marwatk)
- Guillaume Martinez (@Lunik)
@ -45,7 +45,7 @@ options:
type: str
key:
description:
- Deploy key
- Deploy key.
required: true
type: str
can_push:
@ -55,14 +55,14 @@ options:
default: false
state:
description:
- When V(present) the deploy key added to the project if it doesn't exist.
- When V(present) the deploy key added to the project if it does not exist.
- When V(absent) it will be removed from the project if it exists.
default: present
type: str
choices: [ "present", "absent" ]
'''
choices: ["present", "absent"]
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: "Adding a project deploy key"
community.general.gitlab_deploy_key:
api_url: https://gitlab.example.com/
@ -88,32 +88,31 @@ EXAMPLES = '''
project: "my_group/my_project"
state: absent
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
"""
'''
RETURN = '''
RETURN = r"""
msg:
description: Success or failure message
description: Success or failure message.
returned: always
type: str
sample: "Success"
result:
description: json parsed response from the server
description: JSON-parsed response from the server.
returned: always
type: dict
error:
description: the error message returned by the GitLab API
description: The error message returned by the GitLab API.
returned: failed
type: str
sample: "400: key is already in use"
deploy_key:
description: API object
description: API object.
returned: always
type: dict
'''
"""
from ansible.module_utils.api import basic_auth_argument_spec
from ansible.module_utils.basic import AnsibleModule