saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

grains module documentation fixes

Browse source
This commit is contained in:
Christophe Drevet-Droguet 2015-10-13 18:09:48 +02:00 • committed by rallytime
parent 25e9a5c9ad
commit df8ec1184c
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
salt/modules/grains.py
View file

@ -298,7 +298,7 @@ def append(key, val, convert=False, delimiter=DEFAULT_TARGET_DELIM):
is given. Defaults to False.
:param delimiter: The key can be a nested dict key. Use this parameter to
specify the delimiter you use.
specify the delimiter you use, instead of the default ``:``.
You can now append values to a list in nested dictionnary grains. If the
list doesn't exist at this level, it will be created.
.. versionadded:: 2014.7.6
@ -339,7 +339,7 @@ def remove(key, val, delimiter=DEFAULT_TARGET_DELIM):
Remove a value from a list in the grains config file
:param delimiter: The key can be a nested dict key. Use this parameter to
specify the delimiter you use.
specify the delimiter you use, instead of the default ``:``.
You can now append values to a list in nested dictionnary grains. If the
list doesn't exist at this level, it will be created.
.. versionadded:: Boron
@ -555,7 +555,7 @@ def get_or_set_hash(name,
.. warning::
This function could return strings which may contain characters which are reserved
as directives by the YAML parser, such as strings beginning with `%`. To avoid
as directives by the YAML parser, such as strings beginning with ``%``. To avoid
issues when using the output of this function in an SLS file containing YAML+Jinja,
surround the call with single quotes.
'''
@ -586,7 +586,7 @@ def set(key,
with nested keys.
This function is conservative. It will only overwrite an entry if
its value and the given one are not a list or a dict. The `force`
its value and the given one are not a list or a dict. The ``force``
parameter is used to allow overwriting in all cases.
.. versionadded:: 2015.8.0
@ -596,7 +596,8 @@ def set(key,
:param destructive: If an operation results in a key being removed,
delete the key, too. Defaults to False.
:param delimiter:
Specify an alternate delimiter to use when traversing a nested dict
Specify an alternate delimiter to use when traversing a nested dict,
the default being ``:``
CLI Example: