mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-21 09:51:27 -07:00
[PR #9353/70b62ed7 backport][stable-9] s[a-c]*: normalize docs (#9375)
s[a-c]*: normalize docs (#9353)
* s[a-c]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 70b62ed745
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
595c105a29
commit
1ccfc3b821
29 changed files with 336 additions and 382 deletions
|
@ -11,17 +11,16 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: scaleway_private_network
|
||||
short_description: Scaleway private network management
|
||||
version_added: 4.5.0
|
||||
author: Pascal MANGIN (@pastral)
|
||||
description:
|
||||
- "This module manages private network on Scaleway account (U(https://developer.scaleway.com))."
|
||||
- This module manages private network on Scaleway account (U(https://developer.scaleway.com)).
|
||||
extends_documentation_fragment:
|
||||
- community.general.scaleway
|
||||
- community.general.attributes
|
||||
- community.general.scaleway
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
|
@ -33,7 +32,7 @@ options:
|
|||
state:
|
||||
type: str
|
||||
description:
|
||||
- Indicate desired state of the VPC.
|
||||
- Indicate desired state of the VPC.
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
|
@ -48,7 +47,7 @@ options:
|
|||
region:
|
||||
type: str
|
||||
description:
|
||||
- Scaleway region to use (for example V(par1)).
|
||||
- Scaleway region to use (for example V(par1)).
|
||||
required: true
|
||||
choices:
|
||||
- ams1
|
||||
|
@ -63,18 +62,16 @@ options:
|
|||
name:
|
||||
type: str
|
||||
description:
|
||||
- Name of the VPC.
|
||||
|
||||
- Name of the VPC.
|
||||
tags:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- List of tags to apply to the instance.
|
||||
- List of tags to apply to the instance.
|
||||
default: []
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create an private network
|
||||
community.general.scaleway_vpc:
|
||||
project: '{{ scw_project }}'
|
||||
|
@ -88,9 +85,9 @@ EXAMPLES = '''
|
|||
name: 'foo'
|
||||
state: absent
|
||||
region: par1
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
scaleway_private_network:
|
||||
description: Information on the VPC.
|
||||
returned: success when O(state=present)
|
||||
|
@ -112,7 +109,7 @@ scaleway_private_network:
|
|||
"updated_at": "2022-01-15T11:12:04.624837Z",
|
||||
"zone": "fr-par-2"
|
||||
}
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue