From f713a5412a7a133150cc97041c9d925303c3a169 Mon Sep 17 00:00:00 2001 From: jjshoe Date: Mon, 11 Apr 2016 11:51:35 -0500 Subject: [PATCH] Document argument true/false preferences --- docsite/rst/developing_modules.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index 14bb55e3385..f5db5b63d13 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -384,6 +384,8 @@ Include it in your module file like this:: # ... snip ... ''' +If an argument takes both C(True)/C(False) and C(Yes)/C(No), the documentation should use C(True) and C(False). + The ``description``, and ``notes`` fields support formatting with some special macros. @@ -498,6 +500,7 @@ Module checklist * Does module use check_mode? Could it be modified to use it? Document it * Examples: make sure they are reproducible * Return: document the return structure of the module + * If an argument takes both C(True)/C(False) and C(Yes)/C(No), the documentation should use C(True) and C(False). * Exceptions: The module must handle them. (exceptions are bugs) * Give out useful messages on what you were doing and you can add the exception message to that. * Avoid catchall exceptions, they are not very useful unless the underlying API gives very good error messages pertaining the attempted action.