mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 18:31:25 -07:00
l*.py: normalize docs (#9390)
This commit is contained in:
parent
6b7ea3443d
commit
cea6eeef37
25 changed files with 1194 additions and 1350 deletions
|
@ -8,8 +8,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: lbu
|
||||
|
||||
short_description: Local Backup Utility for Alpine Linux
|
||||
|
@ -17,8 +16,7 @@ short_description: Local Backup Utility for Alpine Linux
|
|||
version_added: '0.2.0'
|
||||
|
||||
description:
|
||||
- Manage Local Backup Utility of Alpine Linux in run-from-RAM mode
|
||||
|
||||
- Manage Local Backup Utility of Alpine Linux in run-from-RAM mode.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
||||
|
@ -31,24 +29,24 @@ attributes:
|
|||
options:
|
||||
commit:
|
||||
description:
|
||||
- Control whether to commit changed files.
|
||||
- Control whether to commit changed files.
|
||||
type: bool
|
||||
exclude:
|
||||
description:
|
||||
- List of paths to exclude.
|
||||
- List of paths to exclude.
|
||||
type: list
|
||||
elements: str
|
||||
include:
|
||||
description:
|
||||
- List of paths to include.
|
||||
- List of paths to include.
|
||||
type: list
|
||||
elements: str
|
||||
|
||||
author:
|
||||
- Kaarle Ritvanen (@kunkku)
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# Commit changed files (if any)
|
||||
- name: Commit
|
||||
community.general.lbu:
|
||||
|
@ -59,22 +57,22 @@ EXAMPLES = '''
|
|||
community.general.lbu:
|
||||
commit: true
|
||||
exclude:
|
||||
- /etc/opt
|
||||
- /etc/opt
|
||||
|
||||
# Include paths without committing
|
||||
- name: Include file and directory
|
||||
community.general.lbu:
|
||||
include:
|
||||
- /root/.ssh/authorized_keys
|
||||
- /var/lib/misc
|
||||
'''
|
||||
- /root/.ssh/authorized_keys
|
||||
- /var/lib/misc
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Error message
|
||||
description: Error message.
|
||||
type: str
|
||||
returned: on failure
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue