Fix doctrings and warn message for salt.states.rbenv. Refs #6961.

This commit is contained in:
Pedro Algarvio 2013-09-20 17:02:36 +01:00
parent 96f5e4366c
commit 0eebb64439

View File

@ -102,22 +102,28 @@ def installed(name, default=False, runas=None, user=None):
name
The version of ruby to install
default : False
Whether to make this ruby the default.
runas: None
The user to run rbenv as.
.. deprecated:: 0.17.0
user: None
The user to run rbenv as.
.. versionadded:: 0.17.0
.. versionadded:: 0.16.0
'''
ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}
salt.utils.warn_until(
(0, 19),
'Let\'s support \'runas\' until salt 0.19.0 is out, after which '
'it will stop being supported',
'Please remove \'runas\' support at this stage. \'user\' support was '
'added in 0.17.0',
_dont_call_warnings=True
)
if runas:
@ -188,20 +194,25 @@ def absent(name, runas=None, user=None):
name
The version of ruby to uninstall
runas: None
The user to run rbenv as.
.. deprecated:: 0.17.0
user: None
The user to run rbenv as.
.. versionadded:: 0.17.0
.. versionadded:: 0.16.0
'''
ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}
salt.utils.warn_until(
(0, 19),
'Let\'s support \'runas\' until salt 0.19.0 is out, after which '
'it will stop being supported',
'Please remove \'runas\' support at this stage. \'user\' support was '
'added in 0.17.0',
_dont_call_warnings=True
)
if runas: