From 40af4a144d51663898a1a1f192719c19c69959e2 Mon Sep 17 00:00:00 2001 From: David Passante Date: Fri, 15 Mar 2019 01:14:08 +0100 Subject: [PATCH] Update an example in documentation fields (#53760) According to the `Linking within module documentation` section, the right syntax should be `I(state=present)`. --- docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index 1613567ed3d..5cedd4a51ec 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -117,7 +117,7 @@ Module documentation should briefly and accurately define what each module and o * Descriptions should always start with a capital letter and end with a full stop. Consistency always helps. * Verify that arguments in doc and module spec dict are identical. * For password / secret arguments no_log=True should be set. - * If an optional parameter is sometimes required, reflect this fact in the documentation, e.g. "Required when C(state=present)." + * If an optional parameter is sometimes required, reflect this fact in the documentation, e.g. "Required when I(state=present)." * If your module allows ``check_mode``, reflect this fact in the documentation. Each documentation field is described below. Before committing your module documentation, please test it at the command line and as HTML: