summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Turnbull <james@lovedthanlost.net>2011-07-30 04:22:30 +1000
committerJames Turnbull <james@lovedthanlost.net>2011-07-30 04:22:30 +1000
commit62520a2df03acde975d8d7bd96805e767a9611f4 (patch)
tree264c2349b395932e5598602697ffd02279f86ad6
parentdb7e06e301b689efcd421fd56fb1c23e3595e173 (diff)
downloadpuppet-stdlib-62520a2df03acde975d8d7bd96805e767a9611f4.tar.gz
puppet-stdlib-62520a2df03acde975d8d7bd96805e767a9611f4.tar.bz2
Added doc strings for first five functions
-rw-r--r--lib/puppet/parser/functions/abs.rb2
-rw-r--r--lib/puppet/parser/functions/bool2num.rb4
-rw-r--r--lib/puppet/parser/functions/capitalize.rb2
-rw-r--r--lib/puppet/parser/functions/chomp.rb5
-rw-r--r--lib/puppet/parser/functions/chop.rb7
5 files changed, 18 insertions, 2 deletions
diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb
index 0a554e4..ade5462 100644
--- a/lib/puppet/parser/functions/abs.rb
+++ b/lib/puppet/parser/functions/abs.rb
@@ -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|
diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb
index b2989d0..9a07a8a 100644
--- a/lib/puppet/parser/functions/bool2num.rb
+++ b/lib/puppet/parser/functions/bool2num.rb
@@ -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|
diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb
index f902cb3..640d00b 100644
--- a/lib/puppet/parser/functions/capitalize.rb
+++ b/lib/puppet/parser/functions/capitalize.rb
@@ -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|
diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb
index e1d788a..c99d139 100644
--- a/lib/puppet/parser/functions/chomp.rb
+++ b/lib/puppet/parser/functions/chomp.rb
@@ -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|
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|