diff --git a/docsite/rst/dev_guide/developing_modules.rst b/docsite/rst/dev_guide/developing_modules.rst index 3575f160231..feed460c07a 100644 --- a/docsite/rst/dev_guide/developing_modules.rst +++ b/docsite/rst/dev_guide/developing_modules.rst @@ -426,13 +426,13 @@ for URL, module, italic, and constant-width respectively. It is suggested to use ``C()`` for file and option names, and ``I()`` when referencing parameters; module names should be specified as ``M(module)``. -Examples (which typically contain colons, quotes, etc.) are difficult -to format with YAML, so these must be -written in plain text in an ``EXAMPLES`` string within the module -like this:: +Examples should be written in YAML format in plain text in an +``EXAMPLES`` string within the module like this:: EXAMPLES = ''' - - action: modulename opt1=arg1 opt2=arg2 + - modulename: + opt1: arg1 + opt2: arg2 ''' The EXAMPLES section, just like the documentation section, is required in diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index 94f114cbd2d..5f6a21f3185 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -432,13 +432,13 @@ for URL, module, italic, and constant-width respectively. It is suggested to use ``C()`` for file and option names, and ``I()`` when referencing parameters; module names should be specified as ``M(module)``. -Examples (which typically contain colons, quotes, etc.) are difficult -to format with YAML, so these must be -written in plain text in an ``EXAMPLES`` string within the module -like this:: +Examples should be written in YAML format in plain text in an +``EXAMPLES`` string within the module like this:: EXAMPLES = ''' - - action: modulename opt1=arg1 opt2=arg2 + - modulename: + opt1: arg1 + opt2: arg2 ''' The EXAMPLES section, just like the documentation section, is required in