Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / capitalize.rb
index 2493bc8..ffc4d13 100644 (file)
@@ -4,11 +4,18 @@
 #
 module Puppet::Parser::Functions
   newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC
-    Capitalizes the first letter of a string or array of strings.
+    @summary
+      **Deprecated** Capitalizes the first letter of a string or array of strings.
+
     Requires either a single string or an array as an input.
 
-    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, yhis function has been replaced with a
+      built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize)
+      function.
+
+    @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|