ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 20:01:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Make 'required' optional in module docs (#15906)

Browse source 
Updated module dev docs, doc build, ansible-doc to match
This commit is contained in:
Matt Davis 2016-05-18 16:57:36 -07:00 • committed by Toshio Kuratomi
parent 71a707fba5
commit ec2cb07988
3 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lib/ansible/cli/doc.py
View file

@ -219,9 +219,7 @@ class DocCLI(CLI):
opt = doc['options'][o]
desc = CLI.tty_ify(" ".join(opt['description']))
required = opt.get('required')
if required is None:
raise("Missing required field 'Required'")
required = opt.get('required', False)
if not isinstance(required, bool):
raise("Incorrect value for 'Required', a boolean is needed.: %s" % required)
if required:
@ -275,8 +273,8 @@ class DocCLI(CLI):
if 'choices' in opt:
choices = ", ".join(str(i) for i in opt['choices'])
desc = desc + " (Choices: " + choices + ")"
if 'default' in opt:
default = str(opt['default'])
if 'default' in opt or not required:
default = str(opt.get('default', '(null)'))
desc = desc + " [Default: " + default + "]"
text.append("%s\n" % textwrap.fill(CLI.tty_ify(desc), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))