Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / num2bool.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/num2bool.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/num2bool.rb
index af0e6ed..6e530db 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/num2bool.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/num2bool.rb
@@ -1,22 +1,27 @@
 #
 # num2bool.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:num2bool, :type => :rvalue, :doc => <<-EOS
-This function converts a number or a string representation of a number into a
-true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0
-become true.
-    EOS
-  ) do |arguments|
+  newfunction(:num2bool, :type => :rvalue, :doc => <<-DOC
+    @summary
+      This function converts a number or a string representation of a number into a
+      true boolean.
+
+    > *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System.
+    See the new() function in Puppet for the many available type conversions.
+
+    @return [Boolean]
+        Boolean(0) # false for any zero or negative number
+        Boolean(1) # true for any positive number
+    DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "num2bool(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size != 1
+    raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     number = arguments[0]
 
     case number
-    when Numeric
+    when Numeric # rubocop:disable Lint/EmptyWhen : Required for the module to work
       # Yay, it's a number
     when String
       begin