[PR #9371/13e2097f backport][stable-10] [pi ... prof]*: normalize docs (#9380)

[pi ... prof]*: normalize docs (#9371)

* [pi ... prof]*: normalize docs

* Update plugins/modules/pkg5_publisher.py

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 13e2097f37)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 22:58:57 +01:00 committed by GitHub
parent e38f9e5cfc
commit 45a3396ab0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 702 additions and 766 deletions

View file

@ -8,13 +8,12 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: profitbricks_datacenter
short_description: Create or destroy a ProfitBricks Virtual Datacenter
description:
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency
on profitbricks >= 1.0.0
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency
on profitbricks >= 1.0.0.
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -38,41 +37,41 @@ options:
type: str
required: false
default: us/las
choices: [ "us/las", "de/fra", "de/fkb" ]
choices: ["us/las", "de/fra", "de/fkb"]
subscription_user:
description:
- The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.
- The ProfitBricks username. Overrides the E(PB_SUBSCRIPTION_ID) environment variable.
type: str
required: false
subscription_password:
description:
- THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.
- THe ProfitBricks password. Overrides the E(PB_PASSWORD) environment variable.
type: str
required: false
wait:
description:
- wait for the datacenter to be created before returning
- Wait for the datacenter to be created before returning.
required: false
default: true
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds
- How long before wait gives up, in seconds.
type: int
default: 600
state:
description:
- Create or terminate datacenters.
- "The available choices are: V(present), V(absent)."
- 'The available choices are: V(present), V(absent).'
type: str
required: false
default: 'present'
requirements: [ "profitbricks" ]
requirements: ["profitbricks"]
author: Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com>
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a datacenter
community.general.profitbricks_datacenter:
datacenter: Tardis One
@ -83,7 +82,7 @@ EXAMPLES = '''
datacenter: Tardis One
wait_timeout: 500
state: absent
'''
"""
import re
import time