From 9a9268de0f39f02668e692044f14ee416c9b727d Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Mon, 8 Aug 2016 19:14:13 -0400 Subject: [PATCH] version_added is required for new modules/options --- docsite/rst/developing_modules.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index 3875bbe415..592d575a1d 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -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.