ma*.py: normalize docs (#9389)

* ma*.py: normalize docs

* Update plugins/modules/matrix.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-27 01:40:55 +13:00 committed by GitHub
parent a99f72fc36
commit a9fca56374
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 596 additions and 639 deletions

View file

@ -10,8 +10,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r"""
module: manageiq_policies_info
version_added: 5.8.0
@ -24,16 +23,14 @@ extends_documentation_fragment:
author: Alexei Znamensky (@russoz)
description:
- The manageiq_policies module supports listing policy_profiles in ManageIQ.
options:
resource_type:
type: str
description:
- The type of the resource to obtain the profile for.
required: true
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster',
'data store', 'group', 'resource pool', 'service', 'service template',
'template', 'tenant', 'user']
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template',
'template', 'tenant', 'user']
resource_name:
type: str
description:
@ -44,9 +41,9 @@ options:
description:
- The ID of the resource to obtain the profile for.
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: List current policy_profile and policies for a provider in ManageIQ
community.general.manageiq_policies_info:
resource_name: 'EngLab'
@ -56,9 +53,9 @@ EXAMPLES = '''
username: 'admin'
password: 'smartvm'
register: result
'''
"""
RETURN = '''
RETURN = r"""
profiles:
description:
- List current policy_profile and policies for a provider in ManageIQ.
@ -78,7 +75,7 @@ profiles:
name: schedule compliance after smart state analysis
profile_description: OpenSCAP profile
profile_name: openscap profile
'''
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.manageiq import ManageIQ, manageiq_argument_spec, manageiq_entities