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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_bool.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_bool.rb
index 49075b833..d6f07af00 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_bool.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_bool.rb
@@ -1,37 +1,39 @@
+#
+# validate_bool.rb
+#
 module Puppet::Parser::Functions
+  newfunction(:validate_bool, :doc => <<-DOC
+    @summary
+      Validate that all passed values are either true or false. Abort catalog
+      compilation if any value fails this check.
 
-  newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args|
-    Validate that all passed values are either true or false. Abort catalog
-    compilation if any value fails this check.
+    @return
+      validate boolean
 
-    The following values will pass:
+    @example **Usage**
 
-        $iamtrue = true
-        validate_bool(true)
-        validate_bool(true, true, false, $iamtrue)
+      The following values will pass:
 
-    The following values will fail, causing compilation to abort:
+          $iamtrue = true
+          validate_bool(true)
+          validate_bool(true, true, false, $iamtrue)
 
-        $some_array = [ true ]
-        validate_bool("false")
-        validate_bool("true")
-        validate_bool($some_array)
+      The following values will fail, causing compilation to abort:
 
-    ENDHEREDOC
-
-    # The deprecation function was being called twice, as validate_bool calls is_bool. I have removed it from here so it only calls deprecation once within is_bool.
-    # function_deprecation([:validate_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.'])
-
-    unless args.length > 0 then
-      raise Puppet::ParseError, ("validate_bool(): wrong number of arguments (#{args.length}; must be > 0)")
+          $some_array = [ true ]
+          validate_bool("false")
+          validate_bool("true")
+          validate_bool($some_array)
+      DOC
+             ) do |args|
+    if args.empty?
+      raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)"
     end
 
     args.each do |arg|
       unless function_is_bool([arg])
-        raise Puppet::ParseError, ("#{arg.inspect} is not a boolean.  It looks to be a #{arg.class}")
+        raise Puppet::ParseError, "#{arg.inspect} is not a boolean.  It looks to be a #{arg.class}"
       end
     end
-
   end
-
 end