valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 17:09:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use reStructuredText syntax in example docstring

Browse Source
This commit is contained in:
Baiju Muthukadan 2012-05-14 00:20:33 +05:30
parent 71e68a26f4
commit 8b743099c4
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/ref/modules/index.rst
View File

@ -176,8 +176,9 @@ Documenting Salt modules is easy! Just add a python docstring to the function.
'''
A function to make some spam with eggs!
CLI Example:
salt '*' test.spam eggs
CLI Example::
salt '*' test.spam eggs
'''
return eggs
@ -234,7 +235,8 @@ function, test.ping:
Just used to make sure the minion is up and responding
Return True
CLI Example:
salt '*' test.ping
CLI Example::
salt '*' test.ping
'''
return True