[PR #10409/a36ad54b backport][stable-10] doc style adjustments: modules i* (#10410)

doc style adjustments: modules i* (#10409)

(cherry picked from commit a36ad54)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

Author: patchback[bot]

plugins/modules/ibm_sa_host.py

@@ -41,8 +41,8 @@
     type: str
   domain:
     description:
-      - The domains the cluster will be attached to. To include more than one domain, separate domain names with commas. To
-        include all existing domains, use an asterisk (V(*)).
+      - The domains the cluster is attached to. To include more than one domain, separate domain names with commas. To include
+        all existing domains, use an asterisk (V(*)).
     required: false
     type: str
   iscsi_chap_name:

plugins/modules/icinga2_host.py

@@ -30,13 +30,13 @@
       - HTTP, HTTPS, or FTP URL in the form V((http|https|ftp\)://[user[:pass]]@host.domain[:port]/path).
   use_proxy:
     description:
-      - If V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
+      - If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts.
     type: bool
     default: true
   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
   url_username:
@@ -48,12 +48,12 @@
     type: str
     description:
       - The password for use in HTTP basic authentication.
-      - If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used.
+      - If the O(url_username) parameter is not specified, the O(url_password) parameter is not used.
   force_basic_auth:
     description:
-      - C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice responds to
-        an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail.
-        This option forces the sending of the Basic authentication header upon initial request.
+      - C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice
+        responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins
+        may fail. This option forces the sending of the Basic authentication header upon initial request.
     type: bool
     default: false
   client_cert:

plugins/modules/imc_rest.py

@@ -57,8 +57,8 @@
     description:
       - When used instead of O(path), sets the content of the API requests directly.
       - This may be convenient to template simple requests, for anything complex use the M(ansible.builtin.template) module.
-      - You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream, the Cisco IMC
-        output is subsequently merged.
+      - You can collate multiple IMC XML fragments and they are processed sequentially in a single stream, the Cisco IMC output
+        is subsequently merged.
       - Parameter O(content) is mutual exclusive with parameter O(path).
     type: str
   protocol:
@@ -71,21 +71,21 @@
     description:
       - The socket level timeout in seconds.
       - This is the time that every single connection (every fragment) can spend. If this O(timeout) is reached, the module
-        will fail with a C(Connection failure) indicating that C(The read operation timed out).
+        fails with a C(Connection failure) indicating that C(The read operation timed out).
     default: 60
     type: int
   validate_certs:
     description:
-      - If V(false), SSL certificates will not be validated.
+      - If V(false), SSL certificates are not validated.
       - This should only set to V(false) used on personally controlled sites using self-signed certificates.
     type: bool
     default: true
 notes:
   - The XML fragments do not need an authentication cookie, this is injected by the module automatically.
   - The Cisco IMC XML output is being translated to JSON using the Cobra convention.
   - Any configConfMo change requested has a return status of C(modified), even if there was no actual change from the previous
-    configuration. As a result, this module will always report a change on subsequent runs. In case this behaviour is fixed
-    in a future update to Cisco IMC, this module will automatically adapt.
+    configuration. As a result, this module always reports a change on subsequent runs. In case this behaviour is fixed in
+    a future update to Cisco IMC, this module is meant to automatically adapt.
   - If you get a C(Connection failure) related to C(The read operation timed out) increase the O(timeout) parameter. Some
     XML fragments can take longer than the default timeout.
   - More information about the IMC REST API is available from

plugins/modules/imgadm.py

@@ -44,7 +44,7 @@
     choices: [present, absent, deleted, imported, updated, vacuumed]
     description:
       - State the object operated on should be in. V(imported) is an alias for for V(present) and V(deleted) for V(absent).
-        When set to V(vacuumed) and O(uuid=*), it will remove all unused images.
+        When set to V(vacuumed) and O(uuid=*), it removes all unused images.
     type: str
 
   type:

plugins/modules/influxdb_user.py

@@ -37,7 +37,7 @@
   admin:
     description:
       - Whether the user should be in the admin role or not.
-      - Since version 2.8, the role will also be updated.
+      - Since version 2.8, the role is also updated.
     default: false
     type: bool
   state:
@@ -50,8 +50,8 @@
     description:
       - Privileges to grant to this user.
       - Takes a list of dicts containing the "database" and "privilege" keys.
-      - If this argument is not provided, the current grants will be left alone.
-      - If an empty list is provided, all grants for the user will be removed.
+      - If this argument is not provided, the current grants are left alone.
+      - If an empty list is provided, all grants for the user are removed.
     type: list
     elements: dict
 extends_documentation_fragment:

plugins/modules/ini_file.py

@@ -39,7 +39,7 @@
   section:
     description:
       - Section name in INI file. This is added if O(state=present) automatically when a single value is being set.
-      - If being omitted, the O(option) will be placed before the first O(section).
+      - If being omitted, the O(option) is placed before the first O(section).
       - Omitting O(section) is also required if the config format does not support sections.
     type: str
   section_has_values:
@@ -63,7 +63,7 @@
         elements: str
     description:
       - Among possibly multiple sections of the same name, select the first one that contains matching options and values.
-      - With O(state=present), if a suitable section is not found, a new section will be added, including the required options.
+      - With O(state=present), if a suitable section is not found, a new section is added, including the required options.
       - With O(state=absent), at most one O(section) is removed if it contains the values.
     version_added: 8.6.0
   option:
@@ -100,8 +100,8 @@
         O(option)s with the same name are not touched.
       - If set to V(present) and O(exclusive) set to V(false) the specified O(option=values) lines are added, but the other
         O(option)s with the same name are not touched.
-      - If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines will be added and the other
-        O(option)s with the same name are removed.
+      - If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines are added and the other O(option)s
+        with the same name are removed.
     type: str
     choices: [absent, present]
     default: present
@@ -126,8 +126,8 @@
     version_added: 7.5.0
   create:
     description:
-      - If set to V(false), the module will fail if the file does not already exist.
-      - By default it will create the file if it is missing.
+      - If set to V(false), the module fails if the file does not already exist.
+      - By default it creates the file if it is missing.
     type: bool
     default: true
   allow_no_value:

plugins/modules/installp.py

@@ -47,7 +47,7 @@
     choices: [absent, present]
     default: present
 notes:
-  - If the package is already installed, even the package/fileset is new, the module will not install it.
+  - If the package is already installed, even the package/fileset is new, the module does not install it.
 """
 
 EXAMPLES = r"""

plugins/modules/interfaces_file.py

@@ -45,10 +45,10 @@
   value:
     type: str
     description:
-      - If O(option) is not presented for the O(iface) and O(state) is V(present) option will be added. If O(option) already
-        exists and is not V(pre-up), V(up), V(post-up) or V(down), its value will be updated. V(pre-up), V(up), V(post-up)
-        and V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option
-        set are supported.
+      - If O(option) is not presented for the O(iface) and O(state) is V(present), then O(option) is added. If O(option) already
+        exists and is not V(pre-up), V(up), V(post-up) or V(down), its value is updated. V(pre-up), V(up), V(post-up) and
+        V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option set
+        are supported.
   backup:
     description:
       - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered
@@ -58,12 +58,12 @@
   state:
     type: str
     description:
-      - If set to V(absent) the option or section will be removed if present instead of created.
+      - If set to V(absent) the option or section is removed if present instead of created.
     default: "present"
     choices: ["present", "absent"]
 
 notes:
-  - If option is defined multiple times last one will be updated but all will be deleted in case of an absent state.
+  - If option is defined multiple times last one is updated but all others are deleted in case of an O(state=absent).
 requirements: []
 author: "Roman Belyakovsky (@hryamzik)"
 """

plugins/modules/ipa_dnsrecord.py

@@ -45,33 +45,31 @@
       - Manage DNS record name with this value.
       - Mutually exclusive with O(record_values), and exactly one of O(record_value) and O(record_values) has to be specified.
       - Use O(record_values) if you need to specify multiple values.
-      - In the case of V(A) or V(AAAA) record types, this will be the IP address.
-      - In the case of V(A6) record type, this will be the A6 Record data.
-      - In the case of V(CNAME) record type, this will be the hostname.
-      - In the case of V(DNAME) record type, this will be the DNAME target.
-      - In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
-        record.
-      - In the case of V(PTR) record type, this will be the hostname.
-      - In the case of V(TXT) record type, this will be a text.
-      - In the case of V(SRV) record type, this will be a service record.
-      - In the case of V(MX) record type, this will be a mail exchanger record.
-      - In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
+      - In the case of V(A) or V(AAAA) record types, this is the IP address.
+      - In the case of V(A6) record type, this is the A6 Record data.
+      - In the case of V(CNAME) record type, this is the hostname.
+      - In the case of V(DNAME) record type, this is the DNAME target.
+      - In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
+      - In the case of V(PTR) record type, this is the hostname.
+      - In the case of V(TXT) record type, this is a text.
+      - In the case of V(SRV) record type, this is a service record.
+      - In the case of V(MX) record type, this is a mail exchanger record.
+      - In the case of V(SSHFP) record type, this is an SSH fingerprint record.
     type: str
   record_values:
     description:
       - Manage DNS record name with this value.
       - Mutually exclusive with O(record_value), and exactly one of O(record_value) and O(record_values) has to be specified.
-      - In the case of V(A) or V(AAAA) record types, this will be the IP address.
-      - In the case of V(A6) record type, this will be the A6 Record data.
-      - In the case of V(CNAME) record type, this will be the hostname.
-      - In the case of V(DNAME) record type, this will be the DNAME target.
-      - In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
-        record.
-      - In the case of V(PTR) record type, this will be the hostname.
-      - In the case of V(TXT) record type, this will be a text.
-      - In the case of V(SRV) record type, this will be a service record.
-      - In the case of V(MX) record type, this will be a mail exchanger record.
-      - In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
+      - In the case of V(A) or V(AAAA) record types, this is the IP address.
+      - In the case of V(A6) record type, this is the A6 Record data.
+      - In the case of V(CNAME) record type, this is the hostname.
+      - In the case of V(DNAME) record type, this is the DNAME target.
+      - In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
+      - In the case of V(PTR) record type, this is the hostname.
+      - In the case of V(TXT) record type, this is a text.
+      - In the case of V(SRV) record type, this is a service record.
+      - In the case of V(MX) record type, this is a mail exchanger record.
+      - In the case of V(SSHFP) record type, this is an SSH fingerprint record.
     type: list
     elements: str
   record_ttl:

plugins/modules/ipa_getkeytab.py

@@ -67,15 +67,15 @@
   retrieve_mode:
     description:
       - Retrieve an existing key from the server instead of generating a new one.
-      - This is incompatible with the O(password), and will work only against a IPA server more recent than version 3.3.
+      - This is incompatible with the O(password), and works only against a IPA server more recent than version 3.3.
       - The user requesting the keytab must have access to the keys for this operation to succeed.
-      - Be aware that if set V(true), a new keytab will be generated.
+      - Be aware that if set V(true), a new keytab is generated.
       - This invalidates all previously retrieved keytabs for this service principal.
     type: bool
   encryption_types:
     description:
       - The list of encryption types to use to generate keys.
-      - It will use local client defaults if not provided.
+      - It uses local client defaults if not provided.
       - Valid values depend on the Kerberos library version and configuration.
     type: str
   state: