Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / join.rb
index d2d7019..266ad65 100644 (file)
@@ -3,16 +3,17 @@
 #
 module Puppet::Parser::Functions
   newfunction(:join, :type => :rvalue, :doc => <<-DOC
-    This function joins an array into a string using a separator.
+    @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"
-
-    Note: from Puppet 5.4.0, the compatible function with the same name in Puppet core
-    will be used instead of this function.
+    > **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|