Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_array.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_array.rb
index 1120ce8..d24f75e 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_array.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_array.rb
@@ -2,23 +2,27 @@
 # validate_array.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:validate_array, :doc => <<-'DOC') do |args|
-    Validate that all passed values are array data structures. Abort catalog
-    compilation if any value fails this check.
+  newfunction(:validate_array, :doc => <<-DOC) do |args|
+    @summary
+      Validate that all passed values are array data structures. Abort catalog
+      compilation if any value fails this check.
 
-    The following values will pass:
+    @return
+      validate array
 
-        $my_array = [ 'one', 'two' ]
-        validate_array($my_array)
+    @example **Usage**
+      The following values will pass:
 
-    The following values will fail, causing compilation to abort:
+          $my_array = [ 'one', 'two' ]
+          validate_array($my_array)
 
-        validate_array(true)
-        validate_array('some_string')
-        $undefined = undef
-        validate_array($undefined)
+      The following values will fail, causing compilation to abort:
 
-    DOC
+          validate_array(true)
+          validate_array('some_string')
+          $undefined = undef
+          validate_array($undefined)
+      DOC
 
     function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function,
       with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.'])