cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

version_added is required for new modules/options

Browse source
This commit is contained in:
Brian Coca 2016-08-08 19:14:13 -04:00
parent 718f431466
commit 9a9268de0f
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docsite/rst/developing_modules.rst
View file

@ -643,8 +643,8 @@ The following checklist items are important guidelines for people who want to c
* If `required` is false/missing, `default` may be specified (assumed 'null' if missing). Ensure that the default parameter in docs matches default parameter in code.
* Documenting `default` is not needed for `required: true`.
* Remove unnecessary doc like `aliases: []` or `choices: []`.
* Do not create choices that can be confused for booleans. choices: ['no', 'verify', 'always], 'no' will be seen as a boolean, check basic.py for BOOLEANS_* constantsto see the full lists. If your option IS a boolean, just use `type=bool`, there is no need to populate 'choices'.
* The version is not a float number and value the current development version.
* Do not create choices that can be confused for booleans. choices: ['no', 'verify', 'always], 'no' will be seen as a boolean, check basic.py for BOOLEANS_* constants to see the full lists. If your option IS a boolean, just use `type=bool`, there is no need to populate 'choices'.
* For new modules or options in a module add version_added. The version match the value the current development version, it is a string, not a float, so quote it.
* Verify that arguments in doc and module spec dict are identical.
* For password / secret arguments no_log=True should be set.
* Requirements should be documented, using the `requirements=[]` field.