Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / reject.rb
index 392f62e..6342db6 100644 (file)
@@ -3,21 +3,22 @@
 #
 module Puppet::Parser::Functions
   newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args|
-    This function searches through an array and rejects all elements that match
-    the provided regular expression.
+    @summary
+      This function searches through an array and rejects all elements that match
+      the provided regular expression.
 
-    *Examples:*
+    @return
+      an array containing all the elements which doesn'' match the provided regular expression
 
-        reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
+    @example **Usage**
 
-    Would return:
+      reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
 
-        ['bbb','ccc']
+      Would return: ['bbb','ccc']
 
-    Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the
-    equivalence of the reject() function:
-
-        ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
+    > *Note:*
+    Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function:
+    ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
 DOC
 
     if args.size != 2