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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_undef_values.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_undef_values.rb
index 9e0408299..b00f5e4d4 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_undef_values.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_undef_values.rb
@@ -3,24 +3,26 @@
 #
 module Puppet::Parser::Functions
   newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC
-    Returns a copy of input hash or array with all undefs deleted.
+    @summary
+      Returns a copy of input hash or array with all undefs deleted.
 
-    *Examples:*
+    @example Example usage
 
-        $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
+      $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
+      Would return: {a => 'A', b => '', d => false}
 
-    Would return: {a => 'A', b => '', d => false}
+      While:
+      $array = delete_undef_values(['A','',undef,false])
+      Would return: ['A','',false]
 
-        $array = delete_undef_values(['A','',undef,false])
+    > *Note:*
+    Since Puppet 4.0.0 the equivalent can be performed with the built-in
+    [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:
+    $array.filter |$val| { $val =~ NotUndef }
+    $hash.filter |$key, $val| { $val =~ NotUndef }
 
-    Would return: ['A','',false]
-
-    Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet:
-
-        $array.filter |$val| { $val =~ NotUndef }
-        $hash.filter |$key, $val| { $val =~ NotUndef }
-
-      DOC
+    @return [Array] The given array now issing of undefined values.
+    DOC
              ) do |args|
 
     raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty?