summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/strip.rb
diff options
context:
space:
mode:
authorKen Barber <ken@bob.sh>2011-07-29 22:18:56 +0100
committerKen Barber <ken@bob.sh>2011-07-29 22:18:56 +0100
commit19313b43ea04066a88a0b78e83650ac52785e2e9 (patch)
tree15c8e5de95a4ffa297683a1bdab0d45a1bfb97eb /lib/puppet/parser/functions/strip.rb
parentf9634b7f9b03be86e25dc740cdcda754a0d2bf7d (diff)
(#3) Apply missing documentation to more functions.
Diffstat (limited to 'lib/puppet/parser/functions/strip.rb')
-rw-r--r--lib/puppet/parser/functions/strip.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb
index ebab20e..5f4630d 100644
--- a/lib/puppet/parser/functions/strip.rb
+++ b/lib/puppet/parser/functions/strip.rb
@@ -4,6 +4,14 @@
module Puppet::Parser::Functions
newfunction(:strip, :type => :rvalue, :doc => <<-EOS
+This function removes leading and trailing whitespace from a string or from
+every string inside an array.
+
+*Examples:*
+
+ strip(" aaa ")
+
+Would result in: "aaa"
EOS
) do |arguments|