Skip to content

Commit

Permalink
Merge pull request #1127 from ansible/patchback/backports/stable-2.16…
Browse files Browse the repository at this point in the history
…/be66e621614c40de6759095a1a9bb8b37a14fcf1/pr-1126

[PR #1126/be66e621 backport][stable-2.16] Improve role argspec documentation
  • Loading branch information
oraNod committed Feb 15, 2024
2 parents 28919ca + 9b6fdad commit a0986ae
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,8 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
:author:

* Name of the entry point authors.
* Use a multi-line list if there is more than one author.
* This can be a single string or a list of strings. Use one list entry per author.
If there is only a single author, use a string or a one-element list.

:options:

Expand All @@ -317,6 +318,8 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
:description:

* Detailed explanation of what this option does. It should be written in full sentences.
* This can be a single string or a list of strings. In case this is a list of strings, every list
element is a new paragraph.

:version_added:

Expand All @@ -336,11 +339,11 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.

:default:

* If ``required`` is false/missing, ``default`` may be specified (assumed 'null' if missing).
* If ``required`` is ``false``/missing, ``default`` may be specified (assumed ``null`` if missing).
* Ensure that the default value in the docs matches the default value in the code. The actual
default for the role variable will always come from ``defaults/main.yml``.
* The default field must not be listed as part of the description unless it requires additional information or conditions.
* If the option is a boolean value, you should use `true/false` if you want to be compatible with `ansible-lint`.
* If the option is a boolean value, you should use ``true``/``false`` if you want to be compatible with ``ansible-lint``.

:choices:

Expand Down

0 comments on commit a0986ae

Please sign in to comment.