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

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