should have gone into 52373 (#56306)

This commit is contained in:
Alicia Cozine 2019-05-10 09:59:50 -05:00 committed by Sandra McCann
parent 3fdc4ba6b4
commit 3c8d8b1509

View file

@ -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: