starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 00:22:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Encourage true/false for module documentation (#80060)

Browse Source 
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Kristian Heljas
2023-03-02 13:46:02 -05:00
committed by GitHub
co-authored by Felix Fontein
parent c8f740cfee
commit 02c49ffe60
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
+2 -2
View File
@@ -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: