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_regex.rb;h=36451919db7cfde730ab1eac86d7bc2ef606058f;hp=8093896f4c149987fa14ceae007c051755877116;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_regex.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_regex.rb
index 8093896f4..36451919d 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_regex.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_regex.rb
@@ -4,30 +4,33 @@
 #
 module Puppet::Parser::Functions
   newfunction(:delete_regex, :type => :rvalue, :doc => <<-DOC
-    deletes all instances of a given element that match a regular expression
-    from an array or key from a hash. Multiple regular expressions are assumed
-    to be matched as an OR.
+    @summary
+      Deletes all instances of a given element that match a regular expression
+      from an array or key from a hash.
 
-    *Examples:*
+    Multiple regular expressions are assumed to be matched as an OR.
 
-        delete_regex(['a','b','c','b'], 'b')
-        Would return: ['a','c']
+    @example Example usage
 
-        delete_regex(['a','b','c','b'], ['b', 'c'])
-        Would return: ['a']
+      delete_regex(['a','b','c','b'], 'b')
+      Would return: ['a','c']
 
-        delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b')
-        Would return: {'a'=>1,'c'=>3}
+      delete_regex(['a','b','c','b'], ['b', 'c'])
+      Would return: ['a']
 
-        delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$')
-        Would return: {'b'=>2,'c'=>3}
+      delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b')
+      Would return: {'a'=>1,'c'=>3}
 
-     Note that since Puppet 4 this can be done in general with the filter function:
-
-        ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ }
-        # Would return: ['aaa', 'aca']
+      delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$')
+      Would return: {'b'=>2,'c'=>3}
 
+    > *Note:*
+    Since Puppet 4 this can be done in general with the built-in
+    [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:
+    ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ }
+    Would return: ['aaa', 'aca']
 
+    @return [Array] The given array now missing all targeted values.
   DOC
              ) do |arguments|