diff options
| author | Matt Davis <nitzmahone@users.noreply.github.com> | 2016-05-18 16:57:36 -0700 |
|---|---|---|
| committer | Toshio Kuratomi <a.badger@gmail.com> | 2016-05-18 16:57:36 -0700 |
| commit | ec2cb07988440e2646f9a5d3ed3b663ac3480044 (patch) | |
| tree | e04d6a666117f4c31fbd8c19c4f5dacef354fde6 /hacking | |
| parent | 71a707fba54617f0c9276f42292307711cf44f15 (diff) | |
| download | ansible-ec2cb07988440e2646f9a5d3ed3b663ac3480044.tar.gz | |
Make 'required' optional in module docs (#15906)
Updated module dev docs, doc build, ansible-doc to match
Diffstat (limited to 'hacking')
| -rwxr-xr-x | hacking/module_formatter.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 72245e533e..7a4005c044 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -289,8 +289,10 @@ def process_module(module, options, env, template, outputname, module_map, alias del doc['options'][k]['version_added'] if not 'description' in doc['options'][k]: raise AnsibleError("Missing required description for option %s in %s " % (k, module)) - if not 'required' in doc['options'][k]: - raise AnsibleError("Missing required 'required' for option %s in %s " % (k, module)) + + required_value = doc['options'][k].get('required', False) + if not isinstance(required_value, bool): + raise AnsibleError("Invalid required value '%s' for option '%s' in '%s' (must be truthy)" % (required_value, k, module)) if not isinstance(doc['options'][k]['description'],list): doc['options'][k]['description'] = [doc['options'][k]['description']] |