X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fcapitalize.rb;h=ffc4d13867ed1ac5467362e038348eebbe33006e;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=096bc5dc55e1537d1c696d596c6e91ae37a41901;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
index 096bc5dc5..ffc4d1386 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/capitalize.rb
@@ -2,15 +2,24 @@
 #  capitalize.rb
 #  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
 #
-
 module Puppet::Parser::Functions
-  newfunction(:capitalize, :type => :rvalue, :doc => <<-EOS
-    Capitalizes the first letter of a string or array of strings.
+  newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated** Capitalizes the first letter of a string or array of strings.
+
     Requires either a single string or an array as an input.
-    EOS
-  ) do |arguments|
 
-    raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+    > *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|
+
+    raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     value = arguments[0]
 
@@ -18,12 +27,12 @@ module Puppet::Parser::Functions
       raise(Puppet::ParseError, 'capitalize(): Requires either array or string to work with')
     end
 
-    if value.is_a?(Array)
-      # Numbers in Puppet are often string-encoded which is troublesome ...
-      result = value.collect { |i| i.is_a?(String) ? i.capitalize : i }
-    else
-      result = value.capitalize
-    end
+    result = if value.is_a?(Array)
+               # Numbers in Puppet are often string-encoded which is troublesome ...
+               value.map { |i| i.is_a?(String) ? i.capitalize : i }
+             else
+               value.capitalize
+             end
 
     return result
   end