Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/count.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/count.rb
index 71999a8..c302aa1 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/count.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/count.rb
@@ -3,21 +3,26 @@
 #
 module Puppet::Parser::Functions
   newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC
-    Takes an array as first argument and an optional second argument.
-    Count the number of elements in array that is equal to the second argument.
+    @summary
+      Counts the number of elements in array.
+
+    Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument.
     If called with only an array, it counts the number of elements that are not nil/undef/empty-string.
 
-    Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers
-    to be equal. For strings this means that equality is case sensitive.
+    > *Note:*
+      equality is tested with a Ruby method and it is therefore subject to what Ruby considers
+      to be equal. For strings this means that equality is case sensitive.
 
     In Puppet core, counting can be done in general by using a combination of the core functions
     filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib).
+
     Example below shows counting values that are not undef.
 
-      notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)
+      ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)```
 
     Would notice the value 2.
 
+    @return [Integer] The amount of elements counted within the array
   DOC
              ) do |args|