(abc*, doc frags): style adjustments (#9534)

(cherry picked from commit aac7199)
ansible-collections · Jan 6, 2025 · 2625bee · 2625bee
1 parent 80f43bb
commit 2625bee
Show file tree

Hide file tree

Showing 28 changed files with 222 additions and 216 deletions.
diff --git a/plugins/doc_fragments/clc.py b/plugins/doc_fragments/clc.py
@@ -21,8 +21,8 @@ class ModuleDocFragment(object):
   - E(CLC_V2_API_USERNAME), the account login ID for the Centurylink Cloud.
   - E(CLC_V2_API_PASSWORD), the account password for the Centurylink Cloud.
   - Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account
-    login and password using the HTTP API call @ https://api.ctl.io/v2/authentication/login
-  - E(CLC_V2_API_TOKEN), the API token generated from https://api.ctl.io/v2/authentication/login
+    login and password using the HTTP API call @ U(https://api.ctl.io/v2/authentication/login).
+  - E(CLC_V2_API_TOKEN), the API token generated from U(https://api.ctl.io/v2/authentication/login).
   - E(CLC_ACCT_ALIAS), the account alias associated with the Centurylink Cloud.
   - Users can set E(CLC_V2_API_URL) to specify an endpoint for pointing to a different CLC environment.
 """
diff --git a/plugins/doc_fragments/ldap.py b/plugins/doc_fragments/ldap.py
@@ -14,9 +14,10 @@ class ModuleDocFragment(object):
     # Standard LDAP documentation fragment
     DOCUMENTATION = r"""
 notes:
-  - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
-    install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need
-    to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
+  - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well
+    with the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root
+    to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn)
+    and O(bind_pw).
 options:
   bind_dn:
     description:

diff --git a/plugins/doc_fragments/oracle.py b/plugins/doc_fragments/oracle.py
@@ -40,9 +40,10 @@ class ModuleDocFragment(object):
     type: str
   api_user_key_file:
     description:
-      - Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE) variable,
-        if any, is used. This option is required if the private key is not specified through a configuration file (See O(config_file_location)).
-        If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
+      - Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE)
+        variable, if any, is used. This option is required if the private key is not specified through a configuration file
+        (See O(config_file_location)). If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option
+        must also be provided.
     type: path
   api_user_key_pass_phrase:
     description:

diff --git a/plugins/doc_fragments/oracle_creatable_resource.py b/plugins/doc_fragments/oracle_creatable_resource.py
@@ -12,8 +12,8 @@ class ModuleDocFragment(object):
 options:
   force_create:
     description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation,
-      and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of the
-      resource, even if it already exists. This option is mutually exclusive with O(key_by).
+      and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of
+      the resource, even if it already exists. This option is mutually exclusive with O(key_by).
     default: false
     type: bool
   key_by:

diff --git a/plugins/doc_fragments/utm.py b/plugins/doc_fragments/utm.py
@@ -31,7 +31,8 @@ class ModuleDocFragment(object):
   utm_token:
     description:
       - The token used to identify at the REST-API.
-      - See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
+      - See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter
+        2.4.2.
     type: str
     required: true
   utm_protocol:

diff --git a/plugins/modules/aerospike_migrations.py b/plugins/modules/aerospike_migrations.py
@@ -15,7 +15,8 @@
 description:
   - This can be used to check for migrations in a cluster. This makes it easy to do a rolling upgrade/update on Aerospike
     nodes.
-  - If waiting for migrations is not desired, simply just poll until port 3000 if available or C(asinfo -v status) returns ok.
+  - If waiting for migrations is not desired, simply just poll until port 3000 if available or C(asinfo -v status) returns
+    ok.
 author: "Albert Autin (@Alb0t)"
 extends_documentation_fragment:
   - community.general.attributes

diff --git a/plugins/modules/airbrake_deployment.py b/plugins/modules/airbrake_deployment.py
@@ -71,7 +71,7 @@
     type: str
   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 will not be validated. This should only be used on personally controlled
         sites using self-signed certificates.
     required: false
     default: true

diff --git a/plugins/modules/ali_instance.py b/plugins/modules/ali_instance.py
@@ -172,7 +172,7 @@
     type: int
   instance_ids:
     description:
-      - A list of instance ids. It is required when need to operate existing instances. If it is specified, O(count) will
+      - A list of instance IDs. It is required when need to operate existing instances. If it is specified, O(count) will
         lose efficacy.
     type: list
     elements: str
@@ -554,7 +554,7 @@
       type: str
       sample: 43.0.0.1
     resource_group_id:
-      description: The id of the resource group to which the instance belongs.
+      description: The ID of the resource group to which the instance belongs.
       returned: always
       type: str
       sample: my-ecs-group

diff --git a/plugins/modules/ali_instance_info.py b/plugins/modules/ali_instance_info.py
@@ -297,7 +297,7 @@
       type: str
       sample: 43.0.0.1
     resource_group_id:
-      description: The id of the resource group to which the instance belongs.
+      description: The ID of the resource group to which the instance belongs.
       returned: always
       type: str
       sample: my-ecs-group

diff --git a/plugins/modules/android_sdk.py b/plugins/modules/android_sdk.py
@@ -69,9 +69,9 @@
     it is only possible to answer one license prompt at a time, meaning that instead of installing multiple packages as a
     single invocation of the C(sdkmanager --install) command, it will be done by executing the command independently for each
     package. This makes sure that at most only one license prompt will need to be answered. At the time of writing this module,
-    a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes
-    in the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module
-    will not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
+    a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes in
+    the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module will
+    not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
     in advance, as it is described in the C(sdkmanager) L(documentation,https://developer.android.com/tools/sdkmanager#accept-licenses),
     for instance, using the M(ansible.builtin.command) module.
 seealso:

diff --git a/plugins/modules/bigpanda.py b/plugins/modules/bigpanda.py
@@ -75,7 +75,7 @@
     default: "https://api.bigpanda.io"
   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 will not be validated. This should only be used on personally controlled
         sites using self-signed certificates.
     required: false
     default: true

diff --git a/plugins/modules/btrfs_info.py b/plugins/modules/btrfs_info.py
@@ -49,7 +49,7 @@
         - /dev/sda1
         - /dev/sdb1
     default_subvolume:
-      description: The id of the filesystem's default subvolume.
+      description: The ID of the filesystem's default subvolume.
       type: int
       sample: 5
     subvolumes:

diff --git a/plugins/modules/cargo.py b/plugins/modules/cargo.py
@@ -38,12 +38,12 @@
     elements: str
     required: true
   path:
-    description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words,
-      V(/usr/local) will become V(/usr/local/bin).
+    description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words, V(/usr/local)
+      will become V(/usr/local/bin).
     type: path
   version:
-    description: The version to install. If O(name) contains multiple values, the module will try to install all of them
-      in this version.
+    description: The version to install. If O(name) contains multiple values, the module will try to install all of them in
+      this version.
     type: str
     required: false
   locked:

diff --git a/plugins/modules/catapult.py b/plugins/modules/catapult.py
@@ -47,7 +47,7 @@
   user_id:
     type: str
     description:
-      - User Id from API account page.
+      - User ID from API account page.
     required: true
   api_token:
     type: str
@@ -62,7 +62,7 @@
 
 author: "Jonathan Mainguy (@Jmainguy)"
 notes:
-  - Will return changed even if the media url is wrong.
+  - Will return changed even if the media URL is wrong.
   - Will return changed if the destination number is invalid.
 """
 

diff --git a/plugins/modules/clc_alert_policy.py b/plugins/modules/clc_alert_policy.py
@@ -36,11 +36,11 @@
     type: str
   id:
     description:
-      - The alert policy id. This is mutually exclusive with O(name).
+      - The alert policy ID. This is mutually exclusive with O(name).
     type: str
   alert_recipients:
     description:
-      - A list of recipient email ids to notify the alert. This is required for O(state=present).
+      - A list of recipient email IDs to notify the alert. This is required for O(state=present).
     type: list
     elements: str
   metric:

diff --git a/plugins/modules/clc_blueprint_package.py b/plugins/modules/clc_blueprint_package.py
@@ -27,13 +27,13 @@
 options:
   server_ids:
     description:
-      - A list of server Ids to deploy the blue print package.
+      - A list of server IDs to deploy the blue print package.
     type: list
     required: true
     elements: str
   package_id:
     description:
-      - The package id of the blue print.
+      - The package ID of the blue print.
     type: str
     required: true
   package_params:
@@ -71,7 +71,7 @@
 
 RETURN = r"""
 server_ids:
-  description: The list of server ids that are changed.
+  description: The list of server IDs that are changed.
   returned: success
   type: list
   sample: ["UC1TEST-SERVER1", "UC1TEST-SERVER2"]

diff --git a/plugins/modules/clc_firewall_policy.py b/plugins/modules/clc_firewall_policy.py
@@ -54,7 +54,7 @@
     elements: str
   firewall_policy_id:
     description:
-      - Id of the firewall policy. This is required to update or delete an existing firewall policy.
+      - ID of the firewall policy. This is required to update or delete an existing firewall policy.
     type: str
   source_account_alias:
     description:
@@ -109,7 +109,7 @@
 
 RETURN = r"""
 firewall_policy_id:
-  description: The firewall policy id.
+  description: The firewall policy ID.
   returned: success
   type: str
   sample: fc36f1bfd47242e488a9c44346438c05

diff --git a/plugins/modules/clc_modify_server.py b/plugins/modules/clc_modify_server.py
@@ -27,7 +27,7 @@
 options:
   server_ids:
     description:
-      - A list of server Ids to modify.
+      - A list of server IDs to modify.
     type: list
     required: true
     elements: str
@@ -41,15 +41,15 @@
     type: str
   anti_affinity_policy_id:
     description:
-      - The anti affinity policy id to be set for a hyper scale server. This is mutually exclusive with O(anti_affinity_policy_name).
+      - The anti affinity policy ID to be set for a hyper scale server. This is mutually exclusive with O(anti_affinity_policy_name).
     type: str
   anti_affinity_policy_name:
     description:
       - The anti affinity policy name to be set for a hyper scale server. This is mutually exclusive with O(anti_affinity_policy_id).
     type: str
   alert_policy_id:
     description:
-      - The alert policy id to be associated to the server. This is mutually exclusive with O(alert_policy_name).
+      - The alert policy ID to be associated to the server. This is mutually exclusive with O(alert_policy_name).
     type: str
   alert_policy_name:
     description:
@@ -131,7 +131,7 @@
 
 RETURN = r"""
 server_ids:
-  description: The list of server ids that are changed.
+  description: The list of server IDs that are changed.
   returned: success
   type: list
   sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

diff --git a/plugins/modules/clc_publicip.py b/plugins/modules/clc_publicip.py
@@ -99,7 +99,7 @@
 
 RETURN = r"""
 server_ids:
-  description: The list of server ids that are changed.
+  description: The list of server IDs that are changed.
   returned: success
   type: list
   sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]