Encourage true/false for module documentation (#80060)

Co-authored-by: Felix Fontein <felix@fontein.de>
pull/80122/head
Kristian Heljas 1 year ago committed by GitHub
parent c8f740cfee
commit 02c49ffe60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -162,8 +162,8 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
* If ``required`` is false/missing, ``default`` may be specified (assumed 'null' if missing).
* Ensure that the default value in the docs matches the default value in the code.
* The default field must not be listed as part of the description, unless it requires additional information or conditions.
* If the option is a boolean value, you can use any of the boolean values recognized by Ansible:
(such as true/false or yes/no). Choose the one that reads better in the context of the option.
* If the option is a boolean value, you can use any of the boolean values recognized by Ansible
(such as ``true``/``false`` or ``yes``/``no``). Document booleans as ``true``/``false`` for consistency and compatibility with ansible-lint.
:choices:

Loading…
Cancel
Save