Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / concat.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/concat.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/concat.rb
index 0a49cfe..d3c2e24 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/concat.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/concat.rb
@@ -1,20 +1,27 @@
 #
 # concat.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:concat, :type => :rvalue, :doc => <<-EOS
-Appends the contents of multiple arrays into array 1.
+  newfunction(:concat, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Appends the contents of multiple arrays into array 1.
+
+    @example Example usage
 
-*Example:*
+      concat(['1','2','3'],'4') returns ['1','2','3','4']
+      concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7']
 
-    concat(['1','2','3'],['4','5','6'],['7','8','9'])
+    > *Note:*
+      Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and
+      merge of hashes, and the `<<`` operator for appending:
 
-Would result in:
+    `['1','2','3'] + ['4','5','6'] + ['7','8','9']` returns `['1','2','3','4','5','6','7','8','9']`
+    `[1, 2, 3] << 4` returns `[1, 2, 3, 4]`
+    `[1, 2, 3] << [4, 5]` returns `[1, 2, 3, [4, 5]]`
 
-  ['1','2','3','4','5','6','7','8','9']
-    EOS
-  ) do |arguments|
+    @return [Array] The single concatenated array
+  DOC
+             ) do |arguments|
 
     # Check that more than 2 arguments have been given ...
     raise(Puppet::ParseError, "concat(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2
@@ -30,7 +37,7 @@ Would result in:
     arguments.shift
 
     arguments.each do |x|
-      result = result + (x.is_a?(Array) ? x : [x])
+      result += (x.is_a?(Array) ? x : [x])
     end
 
     return result