mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51:24 -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
|
@ -8,8 +8,7 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: scaleway_volume_info
|
||||
short_description: Gather information about the Scaleway volumes available
|
||||
description:
|
||||
|
@ -37,9 +36,9 @@ options:
|
|||
- EMEA-FR-PAR2
|
||||
- waw1
|
||||
- EMEA-PL-WAW1
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Gather Scaleway volumes information
|
||||
community.general.scaleway_volume_info:
|
||||
region: par1
|
||||
|
@ -47,14 +46,13 @@ EXAMPLES = r'''
|
|||
|
||||
- ansible.builtin.debug:
|
||||
msg: "{{ result.scaleway_volume_info }}"
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
---
|
||||
RETURN = r"""
|
||||
scaleway_volume_info:
|
||||
description:
|
||||
- Response from Scaleway API.
|
||||
- "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)."
|
||||
- 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).'
|
||||
returned: success
|
||||
type: list
|
||||
elements: dict
|
||||
|
@ -73,7 +71,7 @@ scaleway_volume_info:
|
|||
"volume_type": "l_ssd"
|
||||
}
|
||||
]
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.scaleway import (
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue