Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / merge.rb
index 1ca8257..9a0e8c1 100644 (file)
@@ -3,21 +3,21 @@
 #
 module Puppet::Parser::Functions
   newfunction(:merge, :type => :rvalue, :doc => <<-'DOC') do |args|
-    Merges two or more hashes together and returns the resulting hash.
+    @summary
+      Merges two or more hashes together and returns the resulting hash.
 
-    For example:
-
-        $hash1 = {'one' => 1, 'two', => 2}
-        $hash2 = {'two' => 'dos', 'three', => 'tres'}
-        $merged_hash = merge($hash1, $hash2)
-        # The resulting hash is equivalent to:
-        # $merged_hash =  {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
+    @example **Usage**
+      $hash1 = {'one' => 1, 'two', => 2}
+      $hash2 = {'two' => 'dos', 'three', => 'tres'}
+      $merged_hash = merge($hash1, $hash2) # $merged_hash =  {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
 
     When there is a duplicate key, the key in the rightmost hash will "win."
 
-    Note that since Puppet 4.0.0 the same merge can be achieved with the + operator.
+    @return [Hash]
+      The merged hash
 
-        $merged_hash = $hash1 + $hash2
+    Note that since Puppet 4.0.0 the same merge can be achieved with the + operator.
+      `$merged_hash = $hash1 + $hash2`
     DOC
 
     if args.length < 2