Skip to content

add EXAMPLE to sample passwords etc #2574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ When writing module documentation, take the following statements into considerat
* Module documentation should briefly and accurately define what each module and option does and how it works with others in the underlying system.
* Module documentation should be written for a broad audience and be easily understood both by experts and non-experts.
* Descriptions should always start with a capital letter and end with a full stop or period. Consistency always helps.
* For password and secret arguments ``no_log=True`` should be set.
* 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.
* 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.
* If an option is only required in certain conditions, describe those conditions; for example, "Required when I(state=present)."
* If your module allows ``check_mode``, reflect this fact in the documentation.
Expand Down