ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

correct method docs (#55961)

Browse source
This commit is contained in:
Brian Coca 2019-05-01 10:13:57 -04:00 committed by Alicia Cozine
parent 8542459b95
commit ea57377ddf
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/ansible/playbook/attribute.py
View file

@ -52,7 +52,8 @@ class Attribute:
:kwarg isa: The type of the attribute. Allowable values are a string
representation of any yaml basic datatype, python class, or percent.
(Enforced at post-validation time).
:kwarg private: (not used)
:kwarg private: Hides the attribute from being documented.
TODO: it should also should prevent it from being user settable
:kwarg default: Default value if unspecified in the YAML document.
:kwarg required: Whether or not the YAML document must contain this field.
If the attribute is None when post-validated, an error will be raised.