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

plugins/doc_fragments/clc.py

@@ -21,8 +21,8 @@ notes:
   - 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
+    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 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.
 """

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
+  - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well
-    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
+    with the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root
-    to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
+    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:

plugins/doc_fragments/oracle.py

@@ -40,9 +40,10 @@ options:
     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,
+      - Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE)
-        if any, is used. This option is required if the private key is not specified through a configuration file (See O(config_file_location)).
+        variable, if any, is used. This option is required if the private key is not specified through a configuration file
-        If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
+        (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:

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
+      and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of
-      resource, even if it already exists. This option is mutually exclusive with O(key_by).
+      the resource, even if it already exists. This option is mutually exclusive with O(key_by).
     default: false
     type: bool
   key_by:

plugins/doc_fragments/utm.py

@@ -31,7 +31,8 @@ options:
   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:

plugins/modules/aerospike_migrations.py

@@ -15,7 +15,8 @@ short_description: Check or wait for migrations between nodes
 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

plugins/modules/airbrake_deployment.py

@@ -71,7 +71,7 @@ options:
     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

plugins/modules/ali_instance.py

@@ -172,7 +172,7 @@ options:
     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 @@ instances:
       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

plugins/modules/ali_instance_info.py

@@ -297,7 +297,7 @@ instances:
       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

plugins/modules/android_sdk.py

@@ -69,9 +69,9 @@ notes:
     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
+    a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes in
-    in the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module
+    the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module will
-    will not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
+    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:

plugins/modules/bigpanda.py

@@ -75,7 +75,7 @@ options:
     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

plugins/modules/btrfs_info.py

@@ -49,7 +49,7 @@ filesystems:
         - /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:

plugins/modules/cargo.py

@@ -38,12 +38,12 @@ options:
     elements: str
     required: true
   path:
-    description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words,
+    description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words, V(/usr/local)
-      V(/usr/local) will become V(/usr/local/bin).
+      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
+    description: The version to install. If O(name) contains multiple values, the module will try to install all of them in
-      in this version.
+      this version.
     type: str
     required: false
   locked:

plugins/modules/catapult.py

@@ -47,7 +47,7 @@ options:
   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 @@ options:
 
 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.
 """
 

plugins/modules/clc_alert_policy.py

@@ -36,11 +36,11 @@ options:
     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:

plugins/modules/clc_blueprint_package.py

@@ -27,13 +27,13 @@ attributes:
 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 @@ EXAMPLES = r"""
 
 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"]

plugins/modules/clc_firewall_policy.py

@@ -54,7 +54,7 @@ options:
     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 @@ EXAMPLES = r"""
 
 RETURN = r"""
 firewall_policy_id:
-  description: The firewall policy id.
+  description: The firewall policy ID.
   returned: success
   type: str
   sample: fc36f1bfd47242e488a9c44346438c05

plugins/modules/clc_modify_server.py

@@ -27,7 +27,7 @@ attributes:
 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,7 +41,7 @@ options:
     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:
@@ -49,7 +49,7 @@ options:
     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 @@ EXAMPLES = r"""
 
 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"]

plugins/modules/clc_publicip.py

@@ -99,7 +99,7 @@ EXAMPLES = r"""
 
 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"]

plugins/modules/clc_server.py

@@ -137,7 +137,7 @@ options:
     type: str
   public_ip_protocol:
     description:
-      - The protocol to use for the public ip if O(add_public_ip=true).
+      - The protocol to use for the public IP if O(add_public_ip=true).
     type: str
     default: 'TCP'
     choices: ['TCP', 'UDP', 'ICMP']
@@ -245,12 +245,12 @@ EXAMPLES = r"""
 
 RETURN = r"""
 server_ids:
-  description: The list of server ids that are created.
+  description: The list of server IDs that are created.
   returned: success
   type: list
   sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]
 partially_created_server_ids:
-  description: The list of server ids that are partially created.
+  description: The list of server IDs that are partially created.
   returned: success
   type: list
   sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

plugins/modules/clc_server_snapshot.py

@@ -27,7 +27,7 @@ attributes:
 options:
   server_ids:
     description:
-      - The list of CLC server Ids.
+      - The list of CLC server IDs.
     type: list
     required: true
     elements: str
@@ -83,7 +83,7 @@ EXAMPLES = r"""
 
 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"]

plugins/modules/composer.py

@@ -110,7 +110,8 @@ requirements:
   - php
   - composer installed in bin path (recommended C(/usr/local/bin)) or specified in O(composer_executable)
 notes:
-  - Default options that are always appended in each execution are C(--no-ansi), C(--no-interaction) and C(--no-progress) if available.
+  - Default options that are always appended in each execution are C(--no-ansi), C(--no-interaction) and C(--no-progress)
+    if available.
   - We received reports about issues on macOS if composer was installed by Homebrew. Please use the official install method
     to avoid issues.
 """

plugins/modules/consul.py

@@ -16,9 +16,9 @@ description:
   - Registers services and checks for an agent with a Consul cluster. A service is some process running on the agent node
     that should be advertised by Consul's discovery mechanism. It may optionally supply a check definition, a periodic service
     test to notify the Consul cluster of service's health.
-  - Checks may also be registered per node, for example disk usage, or cpu usage and notify the health of the entire node to the cluster.
+  - Checks may also be registered per node, for example disk usage, or cpu usage and notify the health of the entire node
-    Service level checks do not require a check name or id as these are derived by Consul from the Service name and id respectively
+    to the cluster. Service level checks do not require a check name or ID as these are derived by Consul from the Service
-    by appending V(service:) Node level checks require a O(check_name) and optionally a O(check_id).
+    name and ID respectively by appending V(service:) Node level checks require a O(check_name) and optionally a O(check_id).
   - Currently, there is no complete way to retrieve the script, interval or TTL metadata for a registered check. Without this
     metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this
     does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this

plugins/modules/consul_agent_service.py

@@ -70,8 +70,8 @@ options:
     type: int
   enable_tag_override:
     description:
-      - Specifies to disable the anti-entropy feature for this service's tags. If C(EnableTagOverride) is set to true then external
+      - Specifies to disable the anti-entropy feature for this service's tags. If C(EnableTagOverride) is set to true then
-        agents can update this service in the catalog and modify the tags.
+        external agents can update this service in the catalog and modify the tags.
     type: bool
     default: false
   weights:

plugins/modules/consul_binding_rule.py

@@ -14,8 +14,8 @@ module: consul_binding_rule
 short_description: Manipulate Consul binding rules
 version_added: 8.3.0
 description:
-  - Allows the addition, modification and deletion of binding rules in a Consul cluster using the agent. For more details on
+  - Allows the addition, modification and deletion of binding rules in a Consul cluster using the agent. For more details
-    using and configuring binding rules, see U(https://developer.hashicorp.com/consul/api-docs/acl/binding-rules).
+    on using and configuring binding rules, see U(https://developer.hashicorp.com/consul/api-docs/acl/binding-rules).
 author:
   - Florian Apolloner (@apollo13)
 extends_documentation_fragment:

plugins/modules/consul_kv.py

@@ -40,8 +40,8 @@ options:
         contents. If the state is V(present) and O(value) is not set, the existing value associated to the key will be returned.
         The state V(absent) will remove the key/value pair, again C(changed) will be set to V(true) only if the key actually
         existed prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with
-        the states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed) will
+        the states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed)
-        be V(true) if the attempt is successful, V(false) otherwise.
+        will be V(true) if the attempt is successful, V(false) otherwise.
     type: str
     choices: [absent, acquire, present, release]
     default: present

plugins/modules/consul_role.py

@@ -14,8 +14,8 @@ module: consul_role
 short_description: Manipulate Consul roles
 version_added: 7.5.0
 description:
-  - Allows the addition, modification and deletion of roles in a Consul cluster using the agent. For more details on using and
+  - Allows the addition, modification and deletion of roles in a Consul cluster using the agent. For more details on using
-    configuring ACLs, see U(https://www.consul.io/docs/guides/acl.html).
+    and configuring ACLs, see U(https://www.consul.io/docs/guides/acl.html).
 author:
   - Håkon Lerring (@Hakon)
 extends_documentation_fragment:

plugins/modules/consul_session.py

@@ -37,10 +37,11 @@ options:
     type: str
   state:
     description:
-      - Whether the session should be present, in other words it should be created if it does not exist, or absent, removed if present. If created,
+      - Whether the session should be present, in other words it should be created if it does not exist, or absent, removed
-        the O(id) for the session is returned in the output. If V(absent), O(id) is required to remove the session. Info for
+        if present. If created, the O(id) for the session is returned in the output. If V(absent), O(id) is required to remove
-        a single session, all the sessions for a node or all available sessions can be retrieved by specifying V(info), V(node)
+        the session. Info for a single session, all the sessions for a node or all available sessions can be retrieved by
-        or V(list) for the O(state); for V(node) or V(info), the node O(name) or session O(id) is required as parameter.
+        specifying V(info), V(node) or V(list) for the O(state); for V(node) or V(info), the node O(name) or session O(id)
+        is required as parameter.
     choices: [absent, info, list, node, present]
     type: str
     default: present