mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 02:41:25 -07:00
s[o-y]*: normalize docs (#9351)
* s[o-y]*: normalize docs * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/spectrum_model_attrs.py --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
6cd3f79e19
commit
4b23e5ecff
20 changed files with 994 additions and 1174 deletions
|
@ -8,8 +8,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: stacki_host
|
||||
short_description: Add or remove host to stacki front-end
|
||||
description:
|
||||
|
@ -35,8 +34,7 @@ options:
|
|||
type: str
|
||||
stacki_password:
|
||||
description:
|
||||
- Password for authenticating with Stacki API, but if not
|
||||
specified, the environment variable E(stacki_password) is used instead.
|
||||
- Password for authenticating with Stacki API, but if not specified, the environment variable E(stacki_password) is used instead.
|
||||
required: true
|
||||
type: str
|
||||
stacki_endpoint:
|
||||
|
@ -68,7 +66,7 @@ options:
|
|||
description:
|
||||
- Set value to the desired state for the specified host.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
choices: [absent, present]
|
||||
default: present
|
||||
appliance:
|
||||
description:
|
||||
|
@ -96,10 +94,10 @@ options:
|
|||
type: str
|
||||
default: private
|
||||
author:
|
||||
- Hugh Ma (@bbyhuy) <Hugh.Ma@flextronics.com>
|
||||
'''
|
||||
- Hugh Ma (@bbyhuy) <Hugh.Ma@flextronics.com>
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Add a host named test-1
|
||||
community.general.stacki_host:
|
||||
name: test-1
|
||||
|
@ -117,27 +115,27 @@ EXAMPLES = '''
|
|||
stacki_password: pwd
|
||||
stacki_endpoint: url
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
changed:
|
||||
description: response to whether or not the api call completed successfully
|
||||
description: Response to whether or not the api call completed successfully.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
|
||||
stdout:
|
||||
description: the set of responses from the commands
|
||||
description: The set of responses from the commands.
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
stdout_lines:
|
||||
description: the value of stdout split into a list
|
||||
description: The value of stdout split into a list.
|
||||
returned: always
|
||||
type: list
|
||||
sample: [['...', '...'], ['...'], ['...']]
|
||||
'''
|
||||
"""
|
||||
|
||||
import json
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue