Skip to content

Commit

Permalink
Adding the versionadded tag and argument definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
onlyanegg committed May 18, 2018
1 parent f7de312 commit fc5ff22
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion salt/modules/slsutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,28 @@ def merge(obj_a, obj_b, strategy='smart', renderer='yaml', merge_lists=False):

def merge_all(lst, strategy='smart', renderer='yaml', merge_lists=False):
'''
.. versionadded:: Fluorine
Merge a list of objects into each other in order
:type lst: Iterable
:param lst: List of objects to be merged.
:type strategy: String
:param strategy: Merge strategy. See utils.dictupdate.
:type renderer: String
:param renderer:
Renderer type. Used to determine strategy when strategy is 'smart'.
:type merge_lists: Bool
:param merge_lists: Defines whether to merge embedded object lists.
CLI Example:
.. code-block:: shell
> salt-call --output=txt slsutil.merge_all '[{foo: Foo}, {foo: Bar}]'
$ salt-call --output=txt slsutil.merge_all '[{foo: Foo}, {foo: Bar}]'
local: {u'foo': u'Bar'}
'''

Expand Down

0 comments on commit fc5ff22

Please sign in to comment.