Added doc strings for first five functions

This commit is contained in:
James Turnbull 2011-07-30 04:22:30 +10:00
parent db7e06e301
commit 62520a2df0
5 changed files with 18 additions and 2 deletions

View file

@ -4,6 +4,8 @@
module Puppet::Parser::Functions
newfunction(:abs, :type => :rvalue, :doc => <<-EOS
Returns the absolute value of a number, for example -34.56 becomes
34.56. Takes a single integer and float value as an argument.
EOS
) do |arguments|

View file

@ -4,6 +4,10 @@
module Puppet::Parser::Functions
newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS
Converts a boolean to a number. Converts the values:
false, f, 0, n, and no to 0
true, t, 1, y, and yes to 1
Requires a single boolean or string as an input.
EOS
) do |arguments|

View file

@ -4,6 +4,8 @@
module Puppet::Parser::Functions
newfunction(:capitalize, :type => :rvalue, :doc => <<-EOS
Capitalizes the first letter of a string or array of strings.
Requires either a single string or an array as an input.
EOS
) do |arguments|

View file

@ -3,7 +3,10 @@
#
module Puppet::Parser::Functions
newfunction(:chomp, :type => :rvalue, :doc => <<-EOS
newfunction(:chomp, :type => :rvalue, :doc => <<-'EOS'
Removes the record separator from the end of a string or an array of
strings, for example `hello\n` becomes `hello`.
Requires a single string or array as an input.
EOS
) do |arguments|

View file

@ -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|