From 73bed95ead697d0ac583654fc2475f1d7d4e13d1 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Thu, 10 Sep 2020 17:17:13 +0300 Subject: [PATCH] Docsite: add reference to Style guide (#71694) --- docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index d7b64886128..6be4fcd0e7e 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -79,6 +79,8 @@ Module documentation should briefly and accurately define what each module and o * If an option is only sometimes required, describe the conditions. For example, "Required when I(state=present)." * If your module allows ``check_mode``, reflect this fact in the documentation. +To create clear, concise, consistent, and useful documentation, follow the :ref:`style guide `. + Each documentation field is described below. Before committing your module documentation, please test it at the command line and as HTML: * As long as your module file is :ref:`available locally `, you can use ``ansible-doc -t module my_module_name`` to view your module documentation at the command line. Any parsing errors will be obvious - you can view details by adding ``-vvv`` to the command.