File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed
docs/docsite/rst/playbook_guide Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -303,7 +303,8 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
303
303
:author:
304
304
305
305
* 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.
307
308
308
309
:options:
309
310
@@ -317,6 +318,8 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
317
318
:description:
318
319
319
320
* 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.
320
323
321
324
:version_added:
322
325
@@ -336,11 +339,11 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
336
339
337
340
:default:
338
341
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).
340
343
* Ensure that the default value in the docs matches the default value in the code. The actual
341
344
default for the role variable will always come from ``defaults/main.yml ``.
342
345
* 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 ` `.
344
347
345
348
:choices:
346
349
You can’t perform that action at this time.
0 commit comments