ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-08-04 05:04:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[PR #10480/c1bd4611 backport][stable-11] doc style adjustments: modules s* (#10487)

Browse source 
doc style adjustments: modules s* (#10480)

* doc style adjustments: modules s*

* adjust comment indentation

* remove empty RETURN section in stacki_host

* spectrum_model_attrs: improve formatting of example

* Apply suggestions from code review



* Update plugins/modules/spotinst_aws_elastigroup.py



* Update plugins/modules/swdepot.py



---------


(cherry picked from commit c1bd461173)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-07-27 14:34:24 +00:00 • committed by GitHub
commit 9e91fb0704
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 191 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/modules/snap.py
View file

@ -37,8 +37,8 @@ options:
state:
description:
- Desired state of the package.
- When O(state=present) the module will use C(snap install) if the snap is not installed, and C(snap refresh) if it
is installed but from a different channel.
- When O(state=present) the module uses C(snap install) if the snap is not installed, and C(snap refresh) if it is installed
but from a different channel.
default: present
choices: [absent, present, enabled, disabled]
type: str
@ -56,19 +56,19 @@ options:
description:
- Define which release of a snap is installed and tracked for updates. This option can only be specified if there is
a single snap in the task.
- If not passed, the C(snap) command will default to V(stable).
- If the value passed does not contain the C(track), it will default to C(latest). For example, if V(edge) is passed,
the module will assume the channel to be V(latest/edge).
- If not passed, the C(snap) command defaults to V(stable).
- If the value passed does not contain the C(track), it defaults to C(latest). For example, if V(edge) is passed, the
module assumes the channel to be V(latest/edge).
- See U(https://snapcraft.io/docs/channels) for more details about snap channels.
type: str
required: false
options:
description:
- Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option will be applied to
that snap only. If the snap name is omitted, the options will be applied to all snaps listed in O(name). Options will
only be applied to active snaps.
- Options will only be applied when C(state) is set to V(present). This is done after the necessary installation or
refresh (upgrade/downgrade) of all the snaps listed in O(name).
- Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option is applied to that
snap only. If the snap name is omitted, the options are applied to all snaps listed in O(name). Options are only applied
to active snaps.
- Options are only applied when C(state) is set to V(present). This is done after the necessary installation or refresh
(upgrade/downgrade) of all the snaps listed in O(name).
- See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap configuration options.
required: false
type: list