Skip to content

Commit be66e62

Browse files
authored
Improve role argspec documentation (#1126)
* Extend description for 'author'. * Improve option keyword descriptions.
1 parent 8288cbe commit be66e62

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,8 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
303303
:author:
304304

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

308309
:options:
309310

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

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

321324
:version_added:
322325

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

337340
:default:
338341

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

345348
:choices:
346349

0 commit comments

Comments
 (0)