diff options
| author | Kristian Heljas <11139388+kristianheljas@users.noreply.github.com> | 2023-03-02 20:46:02 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-02 13:46:02 -0500 |
| commit | 02c49ffe60a232e2f0b16cc973a909a6ad2ae263 (patch) | |
| tree | c3386d744eef2500a0aeb0d7689820f610a233c5 /docs | |
| parent | c8f740cfee04db8b7078de4613f7c682bc895d59 (diff) | |
| download | ansible-02c49ffe60a232e2f0b16cc973a909a6ad2ae263.tar.gz | |
Encourage true/false for module documentation (#80060)
Co-authored-by: Felix Fontein <felix@fontein.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index f459e43326..e7b5c2d5fb 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -162,8 +162,8 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require * 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 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 can use any of the boolean values recognized by Ansible: - (such as true/false or yes/no). Choose the one that reads better in the context of the option. + * If the option is a boolean value, you can use any of the boolean values recognized by Ansible + (such as ``true``/``false`` or ``yes``/``no``). Document booleans as ``true``/``false`` for consistency and compatibility with ansible-lint. :choices: |