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%2Fcapitalize.rb;h=ffc4d13867ed1ac5467362e038348eebbe33006e;hp=2493bc838f02ac6d209de393b81de42b5626bc98;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
index 2493bc838..ffc4d1386 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
@@ -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|