Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / max.rb
index 60fb94a..00a183a 100644 (file)
@@ -1,17 +1,27 @@
+#
+# max.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:max, :type => :rvalue, :doc => <<-EOS
-    Returns the highest value of all arguments.
+  newfunction(:max, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns the highest value of all arguments.
+
     Requires at least one argument.
-    EOS
-  ) do |args|
 
-    raise(Puppet::ParseError, "max(): Wrong number of arguments " +
-          "need at least one") if args.size == 0
+    @return
+      The highest value among those passed in
+
+    > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function.
+    DOC
+             ) do |args|
+
+    raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty?
 
     # Sometimes we get numbers as numerics and sometimes as strings.
     # We try to compare them as numbers when possible
-    return args.max do |a,b|
-      if a.to_s =~ /\A-?\d+(.\d+)?\z/ and b.to_s =~ /\A-?\d+(.\d+)?\z/ then
+    return args.max do |a, b|
+      if a.to_s =~ %r{\A-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z}
         a.to_f <=> b.to_f
       else
         a.to_s <=> b.to_s