Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Render elements in module doc and sanity test for sub-options #59244

Merged
merged 7 commits into from
Jul 30, 2019
Merged

Render elements in module doc and sanity test for sub-options #59244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c26934a
Render elements in module doc and sanity test for suboptions
ganeshrn Jul 18, 2019
617c770
Add current validate module failures to ignore list
ganeshrn Jul 19, 2019
73330e3
Fix CI failure
ganeshrn Jul 19, 2019
fe8d069
fix rebase conflict
ganeshrn Jul 25, 2019
7567952
Fix CI issues
ganeshrn Jul 25, 2019
16fa045
Fix review comments
ganeshrn Jul 30, 2019
9796903
Add validate-modules failure in ignore list
ganeshrn Jul 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docsite/rst/dev_guide/testing_validate-modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ Errors
336 argument in argument_spec is not a valid python identifier
337 Type value is defined in ``argument_spec`` but documentation doesn't specify a type
338 documentation doesn't specify a type but argument in ``argument_spec`` use default type (``str``)
339 Value for "elements" is valid only when value of "type" is ``list``
340 argument in argument_spec has sub-options but documentation does not define sub-options
..
--------- -------------------
**4xx** **Syntax**
Expand Down
1 change: 1 addition & 0 deletions docs/templates/plugin.rst.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ Parameters
<b>@{ key }@</b>
<div style="font-size: small">
<span style="color: purple">@{ value.type | documented_type }@</span>
{% if value.get('elements') %} / <span style="color: purple">elements=@{ value.elements | documented_type }@</span>{% endif %}
{% if value.get('required', False) %} / <span style="color: red">required</span>{% endif %}
</div>
{% if value.version_added %}<div style="font-style: italic; font-size: small; color: darkgreen">added in @{value.version_added}@</div>{% endif %}
Expand Down