cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix doc formatting

Browse source
This commit is contained in:
Toshio Kuratomi 2015-05-19 15:13:09 -07:00
parent 73804b375e
commit 0bb4101842
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docsite/rst/developing_modules.rst
View file

@ -473,14 +473,14 @@ Module checklist
* Avoid catchall exceptions, they are not very useful unless the underlying API gives very good error messages pertaining the attempted action. * Avoid catchall exceptions, they are not very useful unless the underlying API gives very good error messages pertaining the attempted action.
* The module must not use sys.exit() --> use fail_json() from the module object * The module must not use sys.exit() --> use fail_json() from the module object
* Import custom packages in try/except and handled with fail_json() in main() e.g.:: * Import custom packages in try/except and handled with fail_json() in main() e.g.::
try:
import foo
HAS_LIB=True
except:
HAS_LIB=False
* The return structure should be consistent, even if NA/None are used for keys normally returned under other options. * The return structure should be consistent, even if NA/None are used for keys normally returned under other options.
try:
import foo
HAS_LIB=True
except:
HAS_LIB=False
* Are module actions idempotent? If not document in the descriptions or the notes * Are module actions idempotent? If not document in the descriptions or the notes
* Import module snippets `from ansible.module_utils.basic import *` at the bottom, conserves line numbers for debugging. * Import module snippets `from ansible.module_utils.basic import *` at the bottom, conserves line numbers for debugging.
* Try to normalize parameters with other modules, you can have aliases for when user is more familiar with underlying API name for the option * Try to normalize parameters with other modules, you can have aliases for when user is more familiar with underlying API name for the option