From 62520a2df03acde975d8d7bd96805e767a9611f4 Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Sat, 30 Jul 2011 04:22:30 +1000 Subject: Added doc strings for first five functions --- lib/puppet/parser/functions/chop.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'lib/puppet/parser/functions/chop.rb') diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index 0f9af86..636b990 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -3,7 +3,12 @@ # module Puppet::Parser::Functions - newfunction(:chop, :type => :rvalue, :doc => <<-EOS + newfunction(:chop, :type => :rvalue, :doc => <<-'EOS' + Returns a new string with the last character removed. If the string ends + with `\r\n`, both characters are removed. Applying chop to an empty + string returns an empty string. If you wish to merely remove record + separators then you should use the `chomp` function. + Requires a string or array of strings as input. EOS ) do |arguments| -- cgit v1.2.3