internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 05:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow documentation of module options type (#42285)

Browse Source 
* Allow documentation of module options

Pass through the `type` of a modules option so it's displayed on the
html module docs

* docs
This commit is contained in:
John R Barker
2018-07-05 06:57:58 -07:00
committed by Brian Coca
parent 31dd41e4c5
commit d962611528
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View File

@@ -239,7 +239,9 @@ The following fields can be used and are all required unless specified otherwise
:choices:
List of option values. Should be absent if empty.
:type:
If an argument is ``type='bool'``, this field should be set to ``type: bool`` and no ``choices`` should be specified.
* Specifies the data type that option accepts, must match the ``argspec``.
* If an argument is ``type='bool'``, this field should be set to ``type: bool`` and no ``choices`` should be specified.
:aliases:
List of option name aliases; generally not needed.
:version_added: