mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 19:01:26 -07:00
[PR #9352/9fc3092b backport][stable-9] s[e-n]*: normalize docs (#9398)
s[e-n]*: normalize docs (#9352)
* s[e-n]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* quote line with : and remove extraneous notes
* Update plugins/modules/slack.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/seport.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 9fc3092bb3
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
c64705474d
commit
7506742c38
20 changed files with 627 additions and 689 deletions
|
@ -9,46 +9,45 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: snap_alias
|
||||
short_description: Manages snap aliases
|
||||
version_added: 4.0.0
|
||||
description:
|
||||
- "Manages snaps aliases."
|
||||
- Manages snaps aliases.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: full
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: full
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Desired state of the alias.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- Name of the snap.
|
||||
type: str
|
||||
alias:
|
||||
description:
|
||||
- Aliases to be created or removed.
|
||||
type: list
|
||||
elements: str
|
||||
aliases: [aliases]
|
||||
state:
|
||||
description:
|
||||
- Desired state of the alias.
|
||||
type: str
|
||||
choices: [absent, present]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- Name of the snap.
|
||||
type: str
|
||||
alias:
|
||||
description:
|
||||
- Aliases to be created or removed.
|
||||
type: list
|
||||
elements: str
|
||||
aliases: [aliases]
|
||||
|
||||
author:
|
||||
- Alexei Znamensky (@russoz) <russoz@gmail.com>
|
||||
- Alexei Znamensky (@russoz) <russoz@gmail.com>
|
||||
|
||||
seealso:
|
||||
- module: community.general.snap
|
||||
'''
|
||||
- module: community.general.snap
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# Install "foo" and "bar" snap
|
||||
- name: Create snap alias
|
||||
community.general.snap_alias:
|
||||
|
@ -62,7 +61,7 @@ EXAMPLES = '''
|
|||
- hw
|
||||
- hw2
|
||||
- hw3
|
||||
state: present # optional
|
||||
state: present # optional
|
||||
|
||||
- name: Remove one specific aliases
|
||||
community.general.snap_alias:
|
||||
|
@ -73,15 +72,15 @@ EXAMPLES = '''
|
|||
community.general.snap_alias:
|
||||
name: hello-world
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
snap_aliases:
|
||||
description: The snap aliases after execution. If called in check mode, then the list represents the state before execution.
|
||||
type: list
|
||||
elements: str
|
||||
returned: always
|
||||
'''
|
||||
description: The snap aliases after execution. If called in check mode, then the list represents the state before execution.
|
||||
type: list
|
||||
elements: str
|
||||
returned: always
|
||||
"""
|
||||
|
||||
|
||||
import re
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue