c*.py: normalize docs (#9418)

* c*.py: normalize docs

* fix copy/paste mistake

* 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:
Alexei Znamensky 2024-12-28 02:29:05 +13:00 committed by GitHub
parent 912065ad0e
commit 43599c6850
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1437 additions and 1614 deletions

View file

@ -8,12 +8,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: cloud_init_data_facts
short_description: Retrieve facts of cloud-init
description:
- Gathers facts by reading the status.json and result.json of cloud-init.
- Gathers facts by reading the C(status.json) and C(result.json) of cloud-init.
author: René Moser (@resmo)
extends_documentation_fragment:
- community.general.attributes
@ -22,14 +21,14 @@ extends_documentation_fragment:
options:
filter:
description:
- Filter facts
- Filter facts.
type: str
choices: [ status, result ]
choices: [status, result]
notes:
- See http://cloudinit.readthedocs.io/ for more information about cloud-init.
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Gather all facts of cloud init
community.general.cloud_init_data_facts:
register: result
@ -44,10 +43,9 @@ EXAMPLES = '''
until: "res.cloud_init_data_facts.status.v1.stage is defined and not res.cloud_init_data_facts.status.v1.stage"
retries: 50
delay: 5
'''
"""
RETURN = '''
---
RETURN = r"""
cloud_init_data_facts:
description: Facts of result and status.
returned: success
@ -84,7 +82,7 @@ cloud_init_data_facts:
"stage": null
}
}'
'''
"""
import os