internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-01 00:03:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document boolean default value treatment (#30062)

Browse Source 
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity
This commit is contained in:
Toshio Kuratomi
2017-09-14 13:27:16 -07:00
committed by GitHub
parent 7a12314d54
commit 8a2f069468
3 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View File

@@ -223,6 +223,8 @@ The following fields can be used and are all required unless specified otherwise
* If `required` is false/missing, `default` may be specified (assumed 'null' if missing).
* Ensure that the default parameter in the docs matches the default parameter in the code.
* The default option must not be listed as part of the description.
* 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.
:choices:
List of option values. Should be absent if empty.
:type: