Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / join.rb
index 1c17997..266ad65 100644 (file)
@@ -1,21 +1,24 @@
 #
 # join.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:join, :type => :rvalue, :doc => <<-EOS
-This function joins an array into a string using a separator.
+  newfunction(:join, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** This function joins an array into a string using a separator.
 
-*Examples:*
+    @example Example Usage:
+      join(['a','b','c'], ",") # Results in: "a,b,c"
 
-    join(['a','b','c'], ",")
+    @return [String]
+      The String containing each of the array values
 
-Would result in: "a,b,c"
-    EOS
-  ) do |arguments|
+    > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced
+    with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function.
+    DOC
+             ) do |arguments|
 
     # Technically we support two arguments but only first is mandatory ...
-    raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+    raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     array = arguments[0]