ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-23 19:01:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Use semantic markup (modules r-s) (#6683)

Browse source 
* Use semantic markup.

* Use 'ignore:' for alias reference.

* Ignore sanity errors for older ansible-core versions.

* Improve markup for RHSM modules.

Co-authored-by: Pino Toscano <ptoscano@redhat.com>

* 'ignore:' is no longer needed.

* E() now works better.

---------

Co-authored-by: Pino Toscano <ptoscano@redhat.com>
This commit is contained in:
Felix Fontein 2023-06-15 15:48:51 +02:00 • committed by GitHub
parent 45eb1e3915
commit eff0cb0ed9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
49 changed files with 311 additions and 303 deletions
Download patch file Download diff file Expand all files Collapse all files

6
plugins/modules/shutdown.py
View file

@ -12,9 +12,9 @@ DOCUMENTATION = r'''
module: shutdown
short_description: Shut down a machine
notes:
- C(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use I(search_paths)
- C(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths)
to specify locations to search if the default paths do not work.
- The I(msg) and I(delay) options are not supported when a shutdown command is not found in I(search_paths), instead
- The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead
the module will attempt to shutdown the system by calling C(systemctl shutdown).
description:
- Shut downs a machine.
@ -76,7 +76,7 @@ EXAMPLES = r'''
RETURN = r'''
shutdown:
description: C(true) if the machine has been shut down.
description: V(true) if the machine has been shut down.
returned: always
type: bool
sample: true