fix misc. documentation typos and formatting for modules starting with u-y (#83422)

lib/ansible/modules/uri.py

@@ -22,19 +22,19 @@ options:
       - 'When a list is provided, all ciphers are joined in order with V(:)'
       - See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
         for more details.
-      - The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions
+      - The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
     type: list
     elements: str
     version_added: '2.14'
   decompress:
     description:
-      - Whether to attempt to decompress gzip content-encoded responses
+      - Whether to attempt to decompress gzip content-encoded responses.
     type: bool
     default: true
     version_added: '2.14'
   url:
     description:
-      - HTTP or HTTPS URL in the form (http|https)://host.domain[:port]/path
+      - HTTP or HTTPS URL in the form (http|https)://host.domain[:port]/path.
     type: str
     required: true
   dest:
@@ -58,17 +58,17 @@ options:
         to V(json) it will take an already formatted JSON string or convert a data structure
         into JSON.
       - If O(body_format) is set to V(form-urlencoded) it will convert a dictionary
-        or list of tuples into an 'application/x-www-form-urlencoded' string. (Added in v2.7)
+        or list of tuples into an C(application/x-www-form-urlencoded) string. (Added in v2.7)
       - If O(body_format) is set to V(form-multipart) it will convert a dictionary
-        into 'multipart/form-multipart' body. (Added in v2.10)
+        into C(multipart/form-multipart) body. (Added in v2.10)
     type: raw
   body_format:
     description:
       - The serialization format of the body. When set to V(json), V(form-multipart), or V(form-urlencoded), encodes
-        the body argument, if needed, and automatically sets the Content-Type header accordingly.
+        the body argument, if needed, and automatically sets the C(Content-Type) header accordingly.
       - As of v2.3 it is possible to override the C(Content-Type) header, when
         set to V(json) or V(form-urlencoded) via the O(headers) option.
-      - The 'Content-Type' header cannot be overridden when using V(form-multipart)
+      - The C(Content-Type) header cannot be overridden when using V(form-multipart).
       - V(form-urlencoded) was added in v2.7.
       - V(form-multipart) was added in v2.10.
     type: str
@@ -86,7 +86,7 @@ options:
     description:
       - Whether or not to return the body of the response as a "content" key in
         the dictionary result no matter it succeeded or failed.
-      - Independently of this option, if the reported Content-type is "application/json", then the JSON is
+      - Independently of this option, if the reported C(Content-Type) is C(application/json), then the JSON is
         always loaded into a key called RV(ignore:json) in the dictionary results.
     type: bool
     default: no
@@ -155,7 +155,7 @@ options:
   client_cert:
     description:
       - PEM formatted certificate chain file to be used for SSL client authentication.
-      - This file can also include the key as well, and if the key is included, O(client_key) is not required
+      - This file can also include the key as well, and if the key is included, O(client_key) is not required.
     type: path
     version_added: '2.4'
   client_key:
@@ -166,7 +166,7 @@ options:
     version_added: '2.4'
   ca_path:
     description:
-      - PEM formatted file that contains a CA certificate to be used for validation
+      - PEM formatted file that contains a CA certificate to be used for validation.
     type: path
     version_added: '2.11'
   src:
@@ -195,7 +195,7 @@ options:
     default: true
   unix_socket:
     description:
-    - Path to Unix domain socket to use for connection
+    - Path to Unix domain socket to use for connection.
     type: path
     version_added: '2.8'
   http_agent:
@@ -225,9 +225,9 @@ options:
     version_added: '2.11'
   use_netrc:
     description:
-      - Determining whether to use credentials from ``~/.netrc`` file
+      - Determining whether to use credentials from C(~/.netrc) file.
-      - By default .netrc is used with Basic authentication headers
+      - By default C(.netrc) is used with Basic authentication headers.
-      - When set to False, .netrc credentials are ignored
+      - When V(false), C(.netrc) credentials are ignored.
     type: bool
     default: true
     version_added: '2.14'

lib/ansible/modules/user.py

@@ -37,19 +37,19 @@ options:
         version_added: "2.6"
     non_unique:
         description:
-            - Optionally when used with the -u option, this option allows to change the user ID to a non-unique value.
+            - Optionally when used with the C(-u) option, this option allows to change the user ID to a non-unique value.
         type: bool
         default: no
         version_added: "1.1"
     seuser:
         description:
-            - Optionally sets the seuser type (user_u) on selinux enabled systems.
+            - Optionally sets the C(seuser) type C(user_u) on SELinux enabled systems.
         type: str
         version_added: "2.1"
     group:
         description:
             - Optionally sets the user's primary group (takes a group name).
-            - On macOS, this defaults to V('staff')
+            - On macOS, this defaults to V(staff).
         type: str
     groups:
         description:
@@ -96,7 +96,7 @@ options:
             - To create an account with a locked/disabled password on OpenBSD, set this to V('*************').
             - B(OS X/macOS:) Enter the cleartext password as the value. Be sure to take relevant security precautions.
             - On macOS, the password specified in the C(password) option will always be set, regardless of whether the user account already exists or not.
-            - When the password is passed as an argument, the C(user) module will always return changed to C(true) for macOS systems.
+            - When the password is passed as an argument, the M(ansible.builtin.user) module will always return changed to C(true) for macOS systems.
               Since macOS no longer provides access to the hashed passwords directly.
         type: str
     state:
@@ -154,7 +154,7 @@ options:
     ssh_key_bits:
         description:
             - Optionally specify number of bits in SSH key to create.
-            - The default value depends on ssh-keygen.
+            - The default value depends on C(ssh-keygen).
         type: int
         version_added: "0.9"
     ssh_key_type:
@@ -205,7 +205,7 @@ options:
             - Lock the password (C(usermod -L), C(usermod -U), C(pw lock)).
             - Implementation differs by platform. This option does not always mean the user cannot login using other methods.
             - This option does not disable the user, only lock the password.
-            - This must be set to V(False) in order to unlock a currently locked password. The absence of this parameter will not unlock a password.
+            - This must be set to V(false) in order to unlock a currently locked password. The absence of this parameter will not unlock a password.
             - Currently supported on Linux, FreeBSD, DragonFlyBSD, NetBSD, OpenBSD.
         type: bool
         version_added: "2.6"
@@ -266,7 +266,7 @@ options:
         description:
             - Sets the umask of the user.
             - Currently supported on Linux. Does nothing when used with other platforms.
-            - Requires O(local) is omitted or V(False).
+            - Requires O(local) is omitted or V(false).
         type: str
         version_added: "2.12"
     password_expire_account_disable:

lib/ansible/modules/validate_argument_spec.py

@@ -16,11 +16,11 @@ version_added: "2.11"
 options:
   argument_spec:
     description:
-        - A dictionary like AnsibleModule argument_spec. See R(argument spec definition,argument_spec)
+        - A dictionary like AnsibleModule argument_spec. See R(argument spec definition,argument_spec).
     required: true
   provided_arguments:
     description:
-        - A dictionary of the arguments that will be validated according to argument_spec
+        - A dictionary of the arguments that will be validated according to argument_spec.
 author:
     - Ansible Core Team
 extends_documentation_fragment:
@@ -51,7 +51,7 @@ attributes:
 EXAMPLES = r'''
 - name: verify vars needed for this task file are present when included
   ansible.builtin.validate_argument_spec:
-        argument_spec: '{{ required_data }}'
+    argument_spec: '{{ required_data }}'
   vars:
     required_data:
       # unlike spec file, just put the options in directly

lib/ansible/modules/wait_for_connection.py

@@ -14,7 +14,8 @@ description:
 - Waits for a total of O(timeout) seconds.
 - Retries the transport connection after a timeout of O(connect_timeout).
 - Tests the transport connection every O(sleep) seconds.
-- This module makes use of internal ansible transport (and configuration) and the ping/win_ping module to guarantee correct end-to-end functioning.
+- This module makes use of internal ansible transport (and configuration) and the M(ansible.builtin.ping)/M(ansible.windows.win_ping)
+  modules to guarantee correct end-to-end functioning.
 - This module is also supported for Windows targets.
 version_added: '2.3'
 options:

lib/ansible/modules/yum_repository.py

@@ -23,7 +23,7 @@ options:
         repo in parallel, if possible.
       - In ansible-core 2.11, 2.12, and 2.13 the default value is V(true).
       - This option has been removed in RHEL 8. If you're using one of the
-        versions listed above, you can set this option to None to avoid passing an
+        versions listed above, you can set this option to V(null) to avoid passing an
         unknown configuration option.
       - This parameter is deprecated as it has been removed on systems supported by ansible-core
         and will be removed in ansible-core 2.22.
@@ -76,8 +76,8 @@ options:
     type: str
   description:
     description:
-      - A human-readable string describing the repository. This option corresponds to the "name" property in the repo file.
+      - A human-readable string describing the repository. This option corresponds to the C(name) property in the repo file.
-      - This parameter is only required if O(state) is set to V(present).
+      - This parameter is only required if O(state=present).
     type: str
   enabled:
     description:
@@ -96,7 +96,7 @@ options:
         space separated list. Shell globs using wildcards (for example V(*) and V(?))
         are allowed.
       - The list can also be a regular YAML array.
-      - excludepkgs alias was added in ansible-core 2.18
+      - O(excludepkgs) alias was added in ansible-core 2.18.
     type: list
     elements: str
     aliases:
@@ -137,7 +137,7 @@ options:
   module_hotfixes:
     description:
       - Disable module RPM filtering and make all RPMs from the repository
-        available. The default is V(None).
+        available. The default is V(null).
     version_added: '2.11'
     type: bool
   http_caching:
@@ -213,7 +213,7 @@ options:
       - V(read-only:future) - Commands that are likely to result in running
         other commands which will require the latest metadata. Eg.
         C(yum check-update).
-      - Note that this option does not override "yum clean expire-cache".
+      - Note that this option does not override C(yum clean expire-cache).
       - This parameter is deprecated as it has no effect with dnf as an underlying package manager
         and will be removed in ansible-core 2.22.
     choices: [never, 'read-only:past', 'read-only:present', 'read-only:future']