[PR #6683/eff0cb0e backport][stable-7] Use semantic markup (modules r-s) (#6707)

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

* 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>
(cherry picked from commit eff0cb0ed9)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-06-15 19:05:11 +02:00 committed by GitHub
parent f4af31b76b
commit 34c4b1f367
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
49 changed files with 311 additions and 303 deletions

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