diff options
| author | James Turnbull <james@lovedthanlost.net> | 2011-07-30 04:22:30 +1000 |
|---|---|---|
| committer | James Turnbull <james@lovedthanlost.net> | 2011-07-30 04:22:30 +1000 |
| commit | 62520a2df03acde975d8d7bd96805e767a9611f4 (patch) | |
| tree | 264c2349b395932e5598602697ffd02279f86ad6 /lib/puppet/parser/functions/chop.rb | |
| parent | db7e06e301b689efcd421fd56fb1c23e3595e173 (diff) | |
Added doc strings for first five functions
Diffstat (limited to 'lib/puppet/parser/functions/chop.rb')
| -rw-r--r-- | lib/puppet/parser/functions/chop.rb | 7 |
1 files changed, 6 insertions, 1 deletions
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| |