From 5d9dd5934a5c963fec9536ac9d530489240bc107 Mon Sep 17 00:00:00 2001 From: Jiri Tyr Date: Tue, 7 Feb 2017 11:07:41 +0000 Subject: [PATCH] Making the decoration more clear (#20931) --- docs/docsite/rst/dev_guide/developing_modules_checklist.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst index 27becfef377..05c1eafa92f 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst @@ -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. * Requirements should be documented, using the `requirements=[]` field. * 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)." * 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.