From 95d05543c469232c7f723d305dd5f1b6d3d45e66 Mon Sep 17 00:00:00 2001 From: Martin Schnabel Date: Sun, 18 Dec 2011 22:34:24 +0100 Subject: [PATCH] fix doc strings of some modules --- salt/modules/file.py | 8 ++++---- salt/modules/grains.py | 2 +- salt/modules/shadow.py | 4 ++-- salt/modules/state.py | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/salt/modules/file.py b/salt/modules/file.py index e8511b91c4..5aedd5fc05 100644 --- a/salt/modules/file.py +++ b/salt/modules/file.py @@ -208,7 +208,7 @@ def get_sum(path, form='md5'): CLI Example:: - salt '*' /etc/passwd sha512 + salt '*' file.get_sum /etc/passwd sha512 ''' if not os.path.isfile(path): return 'File not found' @@ -311,9 +311,9 @@ def find(path, *opts): CLI Examples:: - salt '*' / type=f name=\*.bak size=+10m - salt '*' /var mtime=+30d size=+10m print=path,size,mtime - salt '*' /var/log name=\*.[0-9] mtime=+30d size=+10m delete + salt '*' file.find / type=f name=\*.bak size=+10m + salt '*' file.find /var mtime=+30d size=+10m print=path,size,mtime + salt '*' file.find /var/log name=\*.[0-9] mtime=+30d size=+10m delete ''' opts_dict = {} for opt in opts: diff --git a/salt/modules/grains.py b/salt/modules/grains.py index 7953fef40f..9c4a26952d 100644 --- a/salt/modules/grains.py +++ b/salt/modules/grains.py @@ -39,6 +39,6 @@ def ls(): CLI Example:: - salt '*' grains.list + salt '*' grains.ls ''' return sorted(__grains__) diff --git a/salt/modules/shadow.py b/salt/modules/shadow.py index cd683a0aea..0ff3907f92 100644 --- a/salt/modules/shadow.py +++ b/salt/modules/shadow.py @@ -12,7 +12,7 @@ def info(name): CLI Example:: - salt '*' shadow.user root + salt '*' shadow.info root ''' try: data = spwd.getspnam(name) @@ -46,7 +46,7 @@ def set_password(name, password): CLI Example:: - salt '*' root $1$UYCIxa628.9qXjpQCjM4a.. + salt '*' shadow.set_password root $1$UYCIxa628.9qXjpQCjM4a.. ''' s_file = '/etc/shadow' ret = {} diff --git a/salt/modules/state.py b/salt/modules/state.py index a072a37732..853ac7311c 100644 --- a/salt/modules/state.py +++ b/salt/modules/state.py @@ -86,7 +86,7 @@ def sls(mods, env='base'): CLI Example: - salt \* state.modules core,edit.vim dev + salt '*' state.sls core,edit.vim dev ''' st_ = salt.state.HighState(__opts__) if isinstance(mods, str):