summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/grep.rb
diff options
context:
space:
mode:
authorKen Barber <ken@bob.sh>2011-07-29 23:09:30 +0100
committerKen Barber <ken@bob.sh>2011-07-29 23:09:30 +0100
commita1cae426f1d6b8f2c19184ec8aac3ebc47d97744 (patch)
tree2d40ab0b183ae285560569e625ee41df79e39784 /lib/puppet/parser/functions/grep.rb
parent19313b43ea04066a88a0b78e83650ac52785e2e9 (diff)
(#3) Provide documentation for remaining functions.
Diffstat (limited to 'lib/puppet/parser/functions/grep.rb')
-rw-r--r--lib/puppet/parser/functions/grep.rb10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb
index 2caaa6f..ceba9ec 100644
--- a/lib/puppet/parser/functions/grep.rb
+++ b/lib/puppet/parser/functions/grep.rb
@@ -4,6 +4,16 @@
module Puppet::Parser::Functions
newfunction(:grep, :type => :rvalue, :doc => <<-EOS
+This function searches through an array and returns any elements that match
+the provided regular expression.
+
+*Examples:*
+
+ grep(['aaa','bbb','ccc','aaaddd'], 'aaa')
+
+Would return:
+
+ ['aaa','aaaddd']
EOS
) do |arguments|