diff modules/stdlib/lib/puppet/parser/functions/max.rb @ 275:d9352a684e62

Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents c42fb28cff86
children
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/max.rb	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/stdlib/lib/puppet/parser/functions/max.rb	Sun Jan 26 11:36:07 2020 +0000
@@ -3,8 +3,16 @@
 #
 module Puppet::Parser::Functions
   newfunction(:max, :type => :rvalue, :doc => <<-DOC
-    Returns the highest value of all arguments.
+    @summary
+      **Deprecated:** Returns the highest value of all arguments.
+
     Requires at least one argument.
+
+    @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|