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%2Fdowncase.rb;h=a0717ff617ee7472bc92798a73588765cea05f51;hp=0c763752e880a80f0242482819be05409cb4b1fd;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
index 0c763752e..a0717ff61 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
@@ -4,10 +4,17 @@
 #
 module Puppet::Parser::Functions
   newfunction(:downcase, :type => :rvalue, :doc => <<-DOC
-    Converts the case of a string or all strings in an array to lower case.
+    @summary
+      **Deprecated:** Converts the case of a string or all strings in an array to lower case.
 
-    Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core
-    will be used instead of this function.
+    > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function.
+    >
+    This function is an implementation of a Ruby class and might not be UTF8 compatible.
+    To ensure compatibility, use this function with Ruby 2.4.0 or greater.
+
+    @return [String] The converted String, if it was a String that was given
+    @return [Array[String]] The converted Array, if it was a Array that was given
   DOC
              ) do |arguments|