mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-05 07:49:10 -07:00
[onev ... ovh]*.py: normalize docs (#9373)
* [onev ... ovh]*.py: normalize docs * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
13e2097f37
commit
d96e56048f
25 changed files with 956 additions and 1021 deletions
|
@ -7,7 +7,7 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
DOCUMENTATION = r"""
|
||||
module: online_user_info
|
||||
short_description: Gather information about Online user
|
||||
description:
|
||||
|
@ -18,22 +18,22 @@ extends_documentation_fragment:
|
|||
- community.general.online
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Gather Online user info
|
||||
community.general.online_user_info:
|
||||
register: result
|
||||
|
||||
- ansible.builtin.debug:
|
||||
msg: "{{ result.online_user_info }}"
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
online_user_info:
|
||||
description:
|
||||
- Response from Online API.
|
||||
- "For more details please refer to: U(https://console.online.net/en/api/)."
|
||||
- 'For more details please refer to: U(https://console.online.net/en/api/).'
|
||||
returned: success
|
||||
type: dict
|
||||
sample:
|
||||
|
@ -45,7 +45,7 @@ online_user_info:
|
|||
"last_name": "bar",
|
||||
"login": "foobar"
|
||||
}
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.online import (
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue