Module docs fixes. (#81213)

pull/73763/merge
Felix Fontein 1 year ago committed by GitHub
parent c7eca0e5c0
commit dce51f4ff4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -12,7 +12,7 @@ DOCUMENTATION = r'''
module: getent
short_description: A wrapper to the unix getent utility
description:
- Runs getent against one of it's various databases and returns information into
- Runs getent against one of its various databases and returns information into
the host's facts, in a getent_<database> prefixed variable.
version_added: "1.8"
options:

@ -45,7 +45,7 @@ options:
description:
- Will ensure or not that "-o StrictHostKeyChecking=no" is present as an ssh option.
- Be aware that this disables a protection against MITM attacks.
- Those using OpenSSH >= 7.5 might want to set I(ssh_opt) to 'StrictHostKeyChecking=accept-new'
- Those using OpenSSH >= 7.5 might want to set I(ssh_opts) to 'StrictHostKeyChecking=accept-new'
instead, it does not remove the MITM issue but it does restrict it to the first attempt.
type: bool
default: 'no'

@ -114,7 +114,7 @@ author:
'''
EXAMPLES = r"""
# Display facts from all hosts and store them indexed by I(hostname) at C(/tmp/facts).
# Display facts from all hosts and store them indexed by `hostname` at `/tmp/facts`.
# ansible all -m ansible.builtin.setup --tree /tmp/facts
# Display only facts regarding memory found by ansible on all hosts and output them.

@ -47,7 +47,7 @@ options:
description:
- Use file magic and return data about the nature of the file. this uses
the 'file' utility found on most Linux/Unix systems.
- This will add both C(mime_type) and C(charset) fields to the return, if possible.
- This will add both C(mimetype) and C(charset) fields to the return, if possible.
- In Ansible 2.3 this option changed from I(mime) to I(get_mime) and the default changed to C(true).
type: bool
default: yes
@ -326,14 +326,14 @@ stat:
mimetype:
description: file magic data or mime-type
returned: success, path exists and user can read stats and
installed python supports it and the I(mime) option was true, will
installed python supports it and the I(get_mime) option was true, will
return C(unknown) on error.
type: str
sample: application/pdf; charset=binary
charset:
description: file character set or encoding
returned: success, path exists and user can read stats and
installed python supports it and the I(mime) option was true, will
installed python supports it and the I(get_mime) option was true, will
return C(unknown) on error.
type: str
sample: us-ascii

@ -77,7 +77,7 @@ EXAMPLES = r'''
- ansible.builtin.validate_argument_spec:
argument_spec: "{{lookup('ansible.builtin.file', 'nakedoptions.yml'}}"
provided_arguments:
but: "that i can define on the include itself, like in it's C(vars:) keyword"
but: "that i can define on the include itself, like in it's `vars:` keyword"
- name: the include itself
vars:

@ -23,7 +23,7 @@ options:
description:
- This module supports C(yum) (as it always has), this is known as C(yum3)/C(YUM3)/C(yum-deprecated) by
upstream yum developers. As of Ansible 2.7+, this module also supports C(YUM4), which is the
"new yum" and it has an C(dnf) backend. As of ansible-core 2.15+, C(dnf) will auto select the backend
"new yum" and it has an C(dnf) backend. As of ansible-core 2.15+, this module will auto select the backend
based on the C(ansible_pkg_mgr) fact.
- By default, this module will select the backend based on the C(ansible_pkg_mgr) fact.
default: "auto"

Loading…
Cancel
Save