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

Making the decoration more clear (#20931)

Browse source
This commit is contained in:
Jiri Tyr 2017-02-07 11:07:41 +00:00 committed by John R Barker
parent d8e57cc60a
commit 5d9dd5934a
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docsite/rst/dev_guide/developing_modules_checklist.rst
View file

@ -46,7 +46,7 @@ The complete module metadata specification is here: https://github.com/ansible/p
* For password / secret arguments no_log=True should be set. * For password / secret arguments no_log=True should be set.
* Requirements should be documented, using the `requirements=[]` field. * Requirements should be documented, using the `requirements=[]` field.
* Author should be set, with their name and their github id, at the least. * Author should be set, with their name and their github id, at the least.
* Ensure that you make use of U() for urls, C() for files and options, I() for params, M() for modules. * Ensure that you make use of `U()` for URLs, `I()` for option names, `C()` for files and option values, `M()` for module names.
* If an optional parameter is sometimes required this need to be reflected in the documentation, e.g. "Required when C(state=present)." * If an optional parameter is sometimes required this need to be reflected in the documentation, e.g. "Required when C(state=present)."
* Verify that a GPL 3 License header is included. * Verify that a GPL 3 License header is included.
* Does module use check_mode? Could it be modified to use it? Document it. Documentation is everyone's friend. * Does module use check_mode? Could it be modified to use it? Document it. Documentation is everyone's friend.