ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

updated formatting

Browse source
This commit is contained in:
Brian Coca 2015-05-26 15:11:02 -04:00
parent 0f23d8a503
commit c87586e9e5
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docsite/rst/developing_modules.rst
View file

@ -465,9 +465,9 @@ Module checklist
* Author should be set, name and github id at least * Author should be set, name and github id at least
* Made use of U() for urls, C() for files and options, I() for params, M() for modules? * Made use of U() for urls, C() for files and options, I() for params, M() for modules?
* GPL License header * GPL License header
* Does module use check_mode? Could it be modified to use it? Document it
* Examples: make sure they are reproducible * Examples: make sure they are reproducible
* Return: document the return structure of the module * Return: document the return structure of the module
* Does module use check_mode? Could it be modified to use it? Document it
* Exceptions: The module must handle them. (exceptions are bugs) * 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. * 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. * Avoid catchall exceptions, they are not very useful unless the underlying API gives very good error messages pertaining the attempted action.