summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/chop.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/chop.rb')
-rw-r--r--lib/puppet/parser/functions/chop.rb7
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|