X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Ffloor.rb;h=3a6f3c8057765f2d6af4cc3e7abd0e8c74b83519;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=9a6f014d7c1f25ed98983581971e50f67514b8cc;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/floor.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/floor.rb
index 9a6f014d7..3a6f3c805 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/floor.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/floor.rb
@@ -1,22 +1,29 @@
+#
+# floor.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:floor, :type => :rvalue, :doc => <<-EOS
-    Returns the largest integer less or equal to the argument.
+  newfunction(:floor, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Returns the largest integer less or equal to the argument.
+
+    @return
+      the largest integer less or equal to the argument.
     Takes a single numeric value as an argument.
-    EOS
-  ) do |arguments|
 
-    raise(Puppet::ParseError, "floor(): Wrong number of arguments " +
-          "given (#{arguments.size} for 1)") if arguments.size != 1
+    > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with
+    a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function.
+    DOC
+             ) do |arguments|
+
+    raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     begin
       arg = Float(arguments[0])
-    rescue TypeError, ArgumentError => e
-      raise(Puppet::ParseError, "floor(): Wrong argument type " +
-            "given (#{arguments[0]} for Numeric)")
+    rescue TypeError, ArgumentError => _e
+      raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arguments[0]} for Numeric)")
     end
 
-    raise(Puppet::ParseError, "floor(): Wrong argument type " +
-          "given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false
+    raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false
 
     arg.floor
   end