From 17be4ff2f2e508929db4416bc5c32f3b1f3246ff Mon Sep 17 00:00:00 2001 From: Alexei Znamensky Date: Sun, 27 Jul 2025 17:10:19 +1200 Subject: [PATCH] doc style adjustments: modules r* --- plugins/modules/redfish_command.py | 21 +++++++++++---------- plugins/modules/redfish_config.py | 6 +++--- plugins/modules/redhat_subscription.py | 15 +++++++-------- plugins/modules/redis_data.py | 2 +- plugins/modules/redis_data_incr.py | 4 ++-- plugins/modules/rhsm_release.py | 4 ++-- plugins/modules/rhsm_repository.py | 2 +- plugins/modules/riak.py | 4 ++-- plugins/modules/rocketchat.py | 14 +++++++------- plugins/modules/rollbar_deployment.py | 2 +- plugins/modules/rpm_ostree_pkg.py | 2 +- plugins/modules/rundeck_job_run.py | 2 +- plugins/modules/runit.py | 7 ++++--- 13 files changed, 43 insertions(+), 42 deletions(-) diff --git a/plugins/modules/redfish_command.py b/plugins/modules/redfish_command.py index 25f92bd1f7..f8578488e9 100644 --- a/plugins/modules/redfish_command.py +++ b/plugins/modules/redfish_command.py @@ -229,8 +229,8 @@ options: description: - Custom OEM properties for HTTP Multipart Push updates. - If set, then O(update_custom_oem_header) is required too. - - The properties will be passed raw without any validation or conversion by Ansible. This means the content can be a - file, a string, or any other data. If the content is a dict that should be converted to JSON, then the content must + - The properties are passed raw without any validation or conversion by Ansible. This means the content can be a file, + a string, or any other data. If the content is a dictionary that should be converted to JSON, then the content must be converted to JSON before passing it to this module using the P(ansible.builtin.to_json#filter) filter. type: raw version_added: '10.1.0' @@ -830,15 +830,16 @@ return_values: returned: on success type: dict version_added: 6.1.0 - sample: { - "update_status": { - "handle": "/redfish/v1/TaskService/TaskMonitors/735", - "messages": [], - "resets_requested": [], - "ret": true, - "status": "New" + sample: + { + "update_status": { + "handle": "/redfish/v1/TaskService/TaskMonitors/735", + "messages": [], + "resets_requested": [], + "ret": true, + "status": "New" + } } - } """ from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/redfish_config.py b/plugins/modules/redfish_config.py index 8700d4b8de..6eba0b0048 100644 --- a/plugins/modules/redfish_config.py +++ b/plugins/modules/redfish_config.py @@ -166,9 +166,9 @@ options: volume_details: required: false description: - - Setting dict of volume to be created. - - If C(CapacityBytes) key is not specified in this dictionary, the size of the volume will be determined by the Redfish - service. It is possible the size will not be the maximum available size. + - Setting dictionary of volume to be created. + - If C(CapacityBytes) key is not specified in this dictionary, the size of the volume is determined by the Redfish service. + It is possible the size is not the maximum available size. type: dict default: {} version_added: '7.5.0' diff --git a/plugins/modules/redhat_subscription.py b/plugins/modules/redhat_subscription.py index 6818253c9d..165bfb2891 100644 --- a/plugins/modules/redhat_subscription.py +++ b/plugins/modules/redhat_subscription.py @@ -21,7 +21,7 @@ notes: - 'The module tries to use the D-Bus C(rhsm) service (part of C(subscription-manager)) to register, starting from community.general 6.5.0: this is done so credentials (username, password, activation keys) can be passed to C(rhsm) in a secure way. C(subscription-manager) itself gets credentials only as arguments of command line parameters, which is I(not) secure, as they can be easily stolen - by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module will I(not) + by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module does I(not) use D-Bus for registration when trying either to register using O(token), or when specifying O(environment), or when the system is old (typically RHEL 7 older than 7.4, RHEL 6, and older).' - In order to register a system, subscription-manager requires either a username and password, or an activationkey and an @@ -132,10 +132,9 @@ options: pool_ids: description: - Specify subscription pool IDs to consume. - - 'A pool ID may be specified as a C(string) - just the pool ID (for example - V(0123456789abcdef0123456789abcdef)), or as a C(dict) with the pool ID as the key, and a quantity as the value (for - example V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple entitlements - from a pool (the pool must support this).' + - 'A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)), or + as a C(dict) with the pool ID as the key, and a quantity as the value (for example V(0123456789abcdef0123456789abcdef: + 2). If the quantity is provided, it is used to consume multiple entitlements from a pool (the pool must support this).' default: [] type: list elements: raw @@ -167,8 +166,8 @@ options: - Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM server. Syspurpose attributes help attach the most appropriate subscriptions to the system automatically. When C(syspurpose.json) file already contains some attributes, then new attributes overwrite existing attributes. When some attribute is not - listed in the new list of attributes, the existing attribute will be removed from C(syspurpose.json) file. Unknown - attributes are ignored. + listed in the new list of attributes, the existing attribute is removed from C(syspurpose.json) file. Unknown attributes + are ignored. type: dict suboptions: usage: @@ -187,7 +186,7 @@ options: sync: description: - When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this - option is V(false), then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon. + option is V(false), then syspurpose attributes are synchronized with RHSM server by rhsmcertd daemon. type: bool default: false """ diff --git a/plugins/modules/redis_data.py b/plugins/modules/redis_data.py index 03ae78dce3..d9c5de504e 100644 --- a/plugins/modules/redis_data.py +++ b/plugins/modules/redis_data.py @@ -33,7 +33,7 @@ options: type: str expiration: description: - - Expiration time in milliseconds. Setting this flag will always result in a change in the database. + - Expiration time in milliseconds. Setting this flag always results in a change in the database. required: false type: int non_existing: diff --git a/plugins/modules/redis_data_incr.py b/plugins/modules/redis_data_incr.py index 7630d621dc..b0d339c3c0 100644 --- a/plugins/modules/redis_data_incr.py +++ b/plugins/modules/redis_data_incr.py @@ -21,8 +21,8 @@ attributes: support: partial details: - For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise - the module will fail. - - When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present, + the module fails. + - When using C(check_mode) the module tries to calculate the value that Redis would return. If the key is not present, V(0.0) is used as value. diff_mode: support: none diff --git a/plugins/modules/rhsm_release.py b/plugins/modules/rhsm_release.py index 6408d3c171..665c734849 100644 --- a/plugins/modules/rhsm_release.py +++ b/plugins/modules/rhsm_release.py @@ -14,8 +14,8 @@ short_description: Set or Unset RHSM Release version description: - Sets or unsets the release version used by RHSM repositories. notes: - - This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a - system prior to setting the RHSM release. + - This module fails on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system + prior to setting the RHSM release. - It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module. requirements: diff --git a/plugins/modules/rhsm_repository.py b/plugins/modules/rhsm_repository.py index c80caa0d6c..e59fcd27b4 100644 --- a/plugins/modules/rhsm_repository.py +++ b/plugins/modules/rhsm_repository.py @@ -48,7 +48,7 @@ options: purge: description: - Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing - in a list of repositories to the O(name) field. Using this with C(loop) will most likely not have the desired result. + in a list of repositories to the O(name) field. Using this with C(loop) is likely not to have the desired result. type: bool default: false """ diff --git a/plugins/modules/riak.py b/plugins/modules/riak.py index d7b45af5cd..abd6e185d9 100644 --- a/plugins/modules/riak.py +++ b/plugins/modules/riak.py @@ -62,8 +62,8 @@ options: type: str validate_certs: description: - - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using - self-signed certificates. + - If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed + certificates. type: bool default: true """ diff --git a/plugins/modules/rocketchat.py b/plugins/modules/rocketchat.py index 765b7a71e3..0793e9dd38 100644 --- a/plugins/modules/rocketchat.py +++ b/plugins/modules/rocketchat.py @@ -69,7 +69,7 @@ options: description: - Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat. - For example V(:thumbsup:). - - If O(icon_emoji) is set, O(icon_url) will not be used. + - If O(icon_emoji) is set, O(icon_url) is not used. link_names: type: int description: @@ -80,8 +80,8 @@ options: - 0 validate_certs: description: - - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using - self-signed certificates. + - If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed + certificates. type: bool default: true color: @@ -102,10 +102,10 @@ options: - Define a list of attachments. is_pre740: description: - - If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. - This format has been used by the module since its inception, but is no longer supported by Rocket.Chat 7.4.0. - - The default value of the option will change to V(false) eventually. - - This parameter will be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version. + - If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its + inception, but is no longer supported by Rocket.Chat 7.4.0. + - The default value of the option is going to change to V(false) eventually. + - This parameter is going to be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version. type: bool default: true version_added: 10.5.0 diff --git a/plugins/modules/rollbar_deployment.py b/plugins/modules/rollbar_deployment.py index a9658dbadf..e7f8b6387f 100644 --- a/plugins/modules/rollbar_deployment.py +++ b/plugins/modules/rollbar_deployment.py @@ -61,7 +61,7 @@ options: default: 'https://api.rollbar.com/api/1/deploy/' validate_certs: description: - - If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled + - If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled sites using self-signed certificates. required: false default: true diff --git a/plugins/modules/rpm_ostree_pkg.py b/plugins/modules/rpm_ostree_pkg.py index 652801ca67..c9f759a6fa 100644 --- a/plugins/modules/rpm_ostree_pkg.py +++ b/plugins/modules/rpm_ostree_pkg.py @@ -101,7 +101,7 @@ packages: description: A list of packages specified. returned: always type: list - sample: ['nfs-utils'] + sample: ["nfs-utils"] stdout: description: Stdout of rpm-ostree command. returned: always diff --git a/plugins/modules/rundeck_job_run.py b/plugins/modules/rundeck_job_run.py index cb1941ab6a..1c5841b3c5 100644 --- a/plugins/modules/rundeck_job_run.py +++ b/plugins/modules/rundeck_job_run.py @@ -62,7 +62,7 @@ options: type: int description: - Job execution wait timeout in seconds. - - If the timeout is reached, the job will be aborted. + - If the timeout is reached, the job is aborted. - Keep in mind that there is a sleep based on O(wait_execution_delay) after each job status check. default: 120 abort_on_timeout: diff --git a/plugins/modules/runit.py b/plugins/modules/runit.py index f26f241537..5a575fa2ba 100644 --- a/plugins/modules/runit.py +++ b/plugins/modules/runit.py @@ -30,9 +30,10 @@ options: required: true state: description: - - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always - bounce the service (sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send - a HUP (sv reload). V(once) will run a normally downed sv once (sv once), not really an idempotent operation. + - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary. + - V(restarted) always bounces the service (sv restart) and V(killed) always bounces the service (sv force-stop). + - V(reloaded) always sends a HUP (sv reload). + - V(once) runs a normally downed sv once (sv once), not really an idempotent operation. type: str choices: [killed, once, reloaded, restarted, started, stopped] enabled: