Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / downcase.rb
index 0c76375..a0717ff 100644 (file)
@@ -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|