Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/reject.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/reject.rb
index 1953ffc..6342db6 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/reject.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/reject.rb
@@ -1,24 +1,29 @@
 #
 # reject.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:reject, :type => :rvalue, :doc => <<-EOS) do |args|
-This function searches through an array and rejects all elements that match
-the provided regular expression.
+  newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args|
+    @summary
+      This function searches through an array and rejects all elements that match
+      the provided regular expression.
+
+    @return
+      an array containing all the elements which doesn'' match the provided regular expression
 
-*Examples:*
+    @example **Usage**
 
-    reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
+      reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
 
-Would return:
+      Would return: ['bbb','ccc']
 
-    ['bbb','ccc']
-EOS
+    > *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)
+    if args.size != 2
       raise Puppet::ParseError,
-        "reject(): Wrong number of arguments given #{args.size} for 2"
+            "reject(): Wrong number of arguments given #{args.size} for 2"
     end
 
     ary = args[0]