X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fjoin.rb;h=266ad65b9b8a3401cfc40f8896f5fb473f79f7e9;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=1c179974c85f6bb4ef49de3bd0d2867b84720654;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/join.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/join.rb
index 1c179974c..266ad65b9 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/join.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/join.rb
@@ -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]