Rewrote functions documentation to Markdown

10 files changed, 48 insertions, 46 deletions

diff --git a/lib/puppet/parser/functions/defined.rb b/lib/puppet/parser/functions/defined.rb
index 2930a65cc..90632af2f 100644
--- a/lib/puppet/parser/functions/defined.rb
+++ b/lib/puppet/parser/functions/defined.rb
@@ -3,7 +3,7 @@ Puppet::Parser::Functions::newfunction(:defined, :type => :rvalue, :doc => "Dete
   type is defined, either as a native type or a defined type, or whether a class is defined.
   This is useful for checking whether a class is defined and only including it if it is.
   This function can also test whether a resource has been defined, using resource references
-  (e.g., ``if defined(File['/tmp/myfile']) { ... }``).  This function is unfortunately
+  (e.g., `if defined(File['/tmp/myfile']) { ... }`).  This function is unfortunately
   dependent on the parse order of the configuration when testing whether a resource is defined.") do |vals|
     result = false
     vals = [vals] unless vals.is_a?(Array)
diff --git a/lib/puppet/parser/functions/file.rb b/lib/puppet/parser/functions/file.rb
index 963111260..19ab9ba2e 100644
--- a/lib/puppet/parser/functions/file.rb
+++ b/lib/puppet/parser/functions/file.rb
@@ -2,7 +2,7 @@
 
       Puppet::Parser::Functions::newfunction(
         :file, :type => :rvalue,
-        
+
     :doc => "Return the contents of a file.  Multiple files
     can be passed, and the first file that exists will be read in.") do |vals|
       ret = nil
diff --git a/lib/puppet/parser/functions/inline_template.rb b/lib/puppet/parser/functions/inline_template.rb
index 46e000383..9759ff6e1 100644
--- a/lib/puppet/parser/functions/inline_template.rb
+++ b/lib/puppet/parser/functions/inline_template.rb
@@ -1,9 +1,10 @@
 Puppet::Parser::Functions::newfunction(:inline_template, :type => :rvalue, :doc =>
-  "Evaluate a template string and return its value.  See `the templating docs
-  <http://docs.puppetlabs.com/guides/templating.html>`_ for more information.  Note that
-  if multiple template strings are specified, their output is all concatenated
-  and returned as the output of the function.") do |vals|
-    require 'erb'
+  "Evaluate a template string and return its value.  See 
+  [the templating docs](http://docs.puppetlabs.com/guides/templating.html) for 
+  more information.  Note that if multiple template strings are specified, their 
+  output is all concatenated and returned as the output of the function.") do |vals|
+  
+  require 'erb'
 
     vals.collect do |string|
       # Use a wrapper, so the template can't get access to the full
diff --git a/lib/puppet/parser/functions/realize.rb b/lib/puppet/parser/functions/realize.rb
index 4247b8af8..c21ccd14a 100644
--- a/lib/puppet/parser/functions/realize.rb
+++ b/lib/puppet/parser/functions/realize.rb
@@ -5,7 +5,7 @@ Puppet::Parser::Functions::newfunction(:realize, :doc => "Make a virtual object
     when you want to know the name of the virtual object and don't want to
     bother with a full collection.  It is slightly faster than a collection,
     and, of course, is a bit shorter.  You must pass the object using a
-    reference; e.g.: ``realize User[luke]``." ) do |vals|
+    reference; e.g.: `realize User[luke]`." ) do |vals|
     coll = Puppet::Parser::Collector.new(self, :nomatter, nil, nil, :virtual)
     vals = [vals] unless vals.is_a?(Array)
     coll.resources = vals.flatten
diff --git a/lib/puppet/parser/functions/regsubst.rb b/lib/puppet/parser/functions/regsubst.rb
index c0aeef222..f655db7b3 100644
--- a/lib/puppet/parser/functions/regsubst.rb
+++ b/lib/puppet/parser/functions/regsubst.rb
@@ -6,37 +6,37 @@ module Puppet::Parser::Functions
   :doc => "
   Perform regexp replacement on a string or array of strings.
 
-- **Parameters** (in order):
+* *Parameters* (in order):
 
-:target:  The string or array of strings to operate on.  If an array, the replacement will be performed on each of the elements in the array, and the return value will be an array.
+    _target_  The string or array of strings to operate on.  If an array, the replacement will be performed on each of the elements in the array, and the return value will be an array.
 
-:regexp:  The regular expression matching the target string.  If you want it anchored at the start and or end of the string, you must do that with ^ and $ yourself.
+    _regexp_  The regular expression matching the target string.  If you want it anchored at the start and or end of the string, you must do that with ^ and $ yourself.
 
-:replacement:  Replacement string. Can contain back references to what was matched using \\0, \\1, and so on.
+    _replacement_  Replacement string. Can contain back references to what was matched using \\0, \\1, and so on.
 
-:flags:  Optional. String of single letter flags for how the regexp is interpreted:
+    _flags_  Optional. String of single letter flags for how the regexp is interpreted:
 
-  - **E**         Extended regexps
-  - **I**         Ignore case in regexps
-  - **M**         Multiline regexps
-  - **G**         Global replacement; all occurrences of the regexp in each target string will be replaced.  Without this, only the first occurrence will be replaced.
+        - *E*         Extended regexps
+        - *I*         Ignore case in regexps
+        - *M*         Multiline regexps
+        - *G*         Global replacement; all occurrences of the regexp in each target string will be replaced.  Without this, only the first occurrence will be replaced.
 
-:lang:  Optional.  How to handle multibyte characters.  A single-character string with the following values:
+    _lang_  Optional.  How to handle multibyte characters.  A single-character string with the following values:
 
-  - **N**         None
-  - **E**         EUC
-  - **S**         SJIS
-  - **U**         UTF-8
+        - *N*         None
+        - *E*         EUC
+        - *S*         SJIS
+        - *U*         UTF-8
 
-- **Examples**
+* *Examples*
 
-Get the third octet from the node's IP address::
+Get the third octet from the node's IP address:
 
-  $i3 = regsubst($ipaddress,'^([0-9]+)[.]([0-9]+)[.]([0-9]+)[.]([0-9]+)$','\\3')
+    $i3 = regsubst($ipaddress,'^([0-9]+)[.]([0-9]+)[.]([0-9]+)[.]([0-9]+)$','\\3')
 
-Put angle brackets around each octet in the node's IP address::
+Put angle brackets around each octet in the node's IP address:
 
-  $x = regsubst($ipaddress, '([0-9]+)', '<\\1>', 'G')
+    $x = regsubst($ipaddress, '([0-9]+)', '<\\1>', 'G')
 ") \
   do |args|
     unless args.length.between?(3, 5)
diff --git a/lib/puppet/parser/functions/require.rb b/lib/puppet/parser/functions/require.rb
index 3f98c9523..f15046b91 100644
--- a/lib/puppet/parser/functions/require.rb
+++ b/lib/puppet/parser/functions/require.rb
@@ -12,9 +12,8 @@ relationships between classes.  This function is a superset of the
 class depends on the required class.
 
 Warning: using require in place of include can lead to unwanted dependency cycles.
-  For instance the following manifest, with 'require' instead of 'include'
-  would produce a nasty dependence cycle, because notify imposes a before
-  between File[/foo] and Service[foo]::
+  
+For instance the following manifest, with 'require' instead of 'include' would produce a nasty dependence cycle, because notify imposes a before between File[/foo] and Service[foo]:
 
     class myservice {
       service { foo: ensure => running }
diff --git a/lib/puppet/parser/functions/split.rb b/lib/puppet/parser/functions/split.rb
index 5d0a9dabc..52394095a 100644
--- a/lib/puppet/parser/functions/split.rb
+++ b/lib/puppet/parser/functions/split.rb
@@ -6,7 +6,7 @@ module Puppet::Parser::Functions
     :doc => "\
 Split a string variable into an array using the specified split regexp.
 
-  Usage::
+  Usage:
 
     $string     = 'v1.v2:v3.v4'
     $array_var1 = split($string, ':')
diff --git a/lib/puppet/parser/functions/sprintf.rb b/lib/puppet/parser/functions/sprintf.rb
index 5ada0fed7..5eb4a4f9d 100644
--- a/lib/puppet/parser/functions/sprintf.rb
+++ b/lib/puppet/parser/functions/sprintf.rb
@@ -5,7 +5,7 @@ module Puppet::Parser::Functions
 
     :doc => "Perform printf-style formatting of text.
 
-      The first parameter is format string describing how the rest of the parameters should be formatted.  See the documentation for the ``Kernel::sprintf`` function in Ruby for all the details.") do |args|
+      The first parameter is format string describing how the rest of the parameters should be formatted.  See the documentation for the `Kernel::sprintf` function in Ruby for all the details.") do |args|
     raise Puppet::ParseError, 'sprintf() needs at least one argument' if args.length < 1
     fmt = args.shift
     return sprintf(fmt, *args)
diff --git a/lib/puppet/parser/functions/template.rb b/lib/puppet/parser/functions/template.rb
index f51bcc1e2..6fa110332 100644
--- a/lib/puppet/parser/functions/template.rb
+++ b/lib/puppet/parser/functions/template.rb
@@ -1,6 +1,8 @@
 Puppet::Parser::Functions::newfunction(:template, :type => :rvalue, :doc =>
-  "Evaluate a template and return its value.  See `the templating docs
-  <http://docs.puppetlabs.com/guides/templating.html>`_ for more information.
+  "Evaluate a template and return its value.  See
+  [the templating docs](http://docs.puppetlabs.com/guides/templating.html) for 
+  more information.
+  
   Note that if multiple templates are specified, their output is all
   concatenated and returned as the output of the function.") do |vals|
     require 'erb'
diff --git a/lib/puppet/parser/functions/versioncmp.rb b/lib/puppet/parser/functions/versioncmp.rb
index b38406532..94ba3886f 100644
--- a/lib/puppet/parser/functions/versioncmp.rb
+++ b/lib/puppet/parser/functions/versioncmp.rb
@@ -3,26 +3,26 @@ require 'puppet/util/package'
 
       Puppet::Parser::Functions::newfunction(
         :versioncmp, :type => :rvalue,
-        
+
   :doc => "Compares two versions
 
-Prototype::
+Prototype:
 
-  \$result = versioncmp(a, b)
+    \$result = versioncmp(a, b)
 
-  where a and b are arbitrary version strings
+Where a and b are arbitrary version strings
 
-This functions returns a number::
+This functions returns a number:
 
-  * > 0 if version a is greater than version b
-  * == 0 if both version are equals
-  * < 0 if version a is less than version b
+* > 0 if version a is greater than version b
+* == 0 if both version are equals
+* < 0 if version a is less than version b
 
-Example::
+Example:
 
-  if versioncmp('2.6-1', '2.4.5') > 0 {
-    notice('2.6-1 is > than 2.4.5')
-  }
+    if versioncmp('2.6-1', '2.4.5') > 0 {
+        notice('2.6-1 is > than 2.4.5')
+    }
 
 ") do |args|