[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:
patchback[bot] 2024-12-25 21:41:01 +01:00 committed by GitHub
parent 595c105a29
commit 1ccfc3b821
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
29 changed files with 336 additions and 382 deletions

View file

@ -11,18 +11,16 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: scaleway_compute_private_network
short_description: Scaleway compute - private network management
version_added: 5.2.0
author: Pascal MANGIN (@pastral)
description:
- This module add or remove a private network to a compute instance
(U(https://developer.scaleway.com)).
- This module add or remove a private network to a compute instance (U(https://developer.scaleway.com)).
extends_documentation_fragment:
- community.general.scaleway
- community.general.attributes
- community.general.scaleway
- community.general.attributes
attributes:
check_mode:
@ -34,7 +32,7 @@ options:
state:
type: str
description:
- Indicate desired state of the VPC.
- Indicate desired state of the VPC.
default: present
choices:
- present
@ -49,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
@ -64,18 +62,17 @@ options:
compute_id:
type: str
description:
- ID of the compute instance (see M(community.general.scaleway_compute)).
- ID of the compute instance (see M(community.general.scaleway_compute)).
required: true
private_network_id:
type: str
description:
- ID of the private network (see M(community.general.scaleway_private_network)).
- ID of the private network (see M(community.general.scaleway_private_network)).
required: true
"""
'''
EXAMPLES = '''
EXAMPLES = r"""
- name: Plug a VM to a private network
community.general.scaleway_compute_private_network:
project: '{{ scw_project }}'
@ -92,10 +89,9 @@ EXAMPLES = '''
region: par1
compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
"""
'''
RETURN = '''
RETURN = r"""
scaleway_compute_private_network:
description: Information on the VPC.
returned: success when O(state=present)
@ -117,7 +113,8 @@ scaleway_compute_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