From 3c8d8b150965600b50695e77fa8ffb73463b8f6a Mon Sep 17 00:00:00 2001 From: Alicia Cozine <879121+acozine@users.noreply.github.com> Date: Fri, 10 May 2019 09:59:50 -0500 Subject: [PATCH] should have gone into 52373 (#56306) --- 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 8acfcc96ed7..10e3b7280d7 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -120,7 +120,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 I(state=present)." + * 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. Each documentation field is described below. Before committing your module documentation, please test it at the command line and as HTML: