Skip to content

Commit 3cc8ef2

Browse files
samccannpatchback[bot]
authored andcommitted
add EXAMPLE to sample passwords etc (#2574)
(cherry picked from commit 5edf2b2)
1 parent 98ddf8f commit 3cc8ef2

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/docsite/rst/dev_guide/developing_modules_documenting.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ When writing module documentation, take the following statements into considerat
9696
* Module documentation should briefly and accurately define what each module and option does and how it works with others in the underlying system.
9797
* Module documentation should be written for a broad audience and be easily understood both by experts and non-experts.
9898
* Descriptions should always start with a capital letter and end with a full stop or period. Consistency always helps.
99-
* For password and secret arguments ``no_log=True`` should be set.
99+
* For password and secret arguments ``no_log=True`` should be set and any example passwords, secrets, or hashes should start with ``EXAMPLE`` to ensure no real passwords and so on are leaked.
100100
* For arguments that seem to contain sensitive information but **do not** contain secrets, such as "password_length", set ``no_log=False`` to disable the warning message.
101101
* If an option is only required in certain conditions, describe those conditions; for example, "Required when I(state=present)."
102102
* If your module allows ``check_mode``, reflect this fact in the documentation.

0 commit comments

Comments
 (0)