Added doc strings for first five functions

diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb
index 0a554e4f2302b7c30a77b1d57a4d0a078e5f9f66..ade5462781fda5e173e76b10484e93aabd5e8694 100644 (file)
--- 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 b2989d03d10ac9806ed94e7d424e168584716d6a..9a07a8a11929be7a72eb6757551ed3687874f69e 100644 (file)
--- 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 f902cb34806badb9a5ed4027174a159e5af53517..640d00b82fa681297d48437a252d64a5c92e512d 100644 (file)
--- 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 e1d788a6ee6af29d8e12531b9155b3d4ac30e8a8..c99d139dabd8ea71f21d59b2e46bd6632d4d2dd9 100644 (file)
--- 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 0f9af868e78c6434a3c8e9b844720fb60acf4039..636b990d21d7b5b65b693399b7cb98caf662938c 100644 (file)
--- 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|