diff modules/stdlib/lib/puppet/parser/functions/join.rb @ 275:d9352a684e62

Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents c42fb28cff86
children
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/join.rb	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/stdlib/lib/puppet/parser/functions/join.rb	Sun Jan 26 11:36:07 2020 +0000
@@ -3,13 +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:** **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|