diff options
| author | Sandra Wills <swills@ansible.com> | 2016-04-11 13:17:14 -0400 |
|---|---|---|
| committer | Sandra Wills <swills@ansible.com> | 2016-04-11 13:17:14 -0400 |
| commit | 52ced7c4c97af0b76a2cf32a3b03b693344dfaf1 (patch) | |
| tree | ea04c59dcb39b4c619810d333b9b5a008f61db83 | |
| parent | 13f00f3073dea6cd8ec07fb998c11ffc221275e6 (diff) | |
| download | ansible-revert-15369-patch-2.tar.gz | |
Revert "Document argument true/false preferences"revert-15369-patch-2
| -rw-r--r-- | docsite/rst/developing_modules.rst | 3 |
1 files changed, 0 insertions, 3 deletions
diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index f5db5b63d1..14bb55e338 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -384,8 +384,6 @@ 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. @@ -500,7 +498,6 @@ 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. |