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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb
index fcdc7e1d8..c3b0dfdc6 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb
@@ -1,35 +1,42 @@
+#
+# validate_hash.rb
+#
 module Puppet::Parser::Functions
+  newfunction(:validate_hash, :doc => <<-DOC
+    @summary
+      Validate that all passed values are hash data structures. Abort catalog
+      compilation if any value fails this check.
 
-  newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args|
-    Validate that all passed values are hash data structures. Abort catalog
-    compilation if any value fails this check.
+    @return
+      validate hash
 
-    The following values will pass:
+    @example **Usage**
 
-        $my_hash = { 'one' => 'two' }
-        validate_hash($my_hash)
+      The following values will pass:
 
-    The following values will fail, causing compilation to abort:
+          $my_hash = { 'one' => 'two' }
+          validate_hash($my_hash)
 
-        validate_hash(true)
-        validate_hash('some_string')
-        $undefined = undef
-        validate_hash($undefined)
+      The following values will fail, causing compilation to abort:
 
-    ENDHEREDOC
+          validate_hash(true)
+          validate_hash('some_string')
+          $undefined = undef
+          validate_hash($undefined)
+    DOC
+             ) do |args|
 
-    function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.'])
+    function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function,
+                          with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.'])
 
-    unless args.length > 0 then
-      raise Puppet::ParseError, ("validate_hash(): wrong number of arguments (#{args.length}; must be > 0)")
+    if args.empty?
+      raise Puppet::ParseError, "validate_hash(): wrong number of arguments (#{args.length}; must be > 0)"
     end
 
     args.each do |arg|
       unless arg.is_a?(Hash)
-        raise Puppet::ParseError, ("#{arg.inspect} is not a Hash.  It looks to be a #{arg.class}")
+        raise Puppet::ParseError, "#{arg.inspect} is not a Hash.  It looks to be a #{arg.class}"
       end
     end
-
   end
-
 end