summaryrefslogtreecommitdiff
path: root/plugins/puppet/parser/functions/split.rb
diff options
context:
space:
mode:
authorDavid Schmitt <david@dasz.at>2009-06-09 17:51:10 +0200
committerDavid Schmitt <david@dasz.at>2009-06-09 17:51:10 +0200
commitde7690c4e76ddd7c1f01d81fe92c75771da47c51 (patch)
tree1cba3866aa6db7beb2ba59bddefb508b5d0ddbb7 /plugins/puppet/parser/functions/split.rb
parentc65920d6b8d017c951838c72f4bbcb75d5b27234 (diff)
RDoc-ify documentation
See http://club.black.co.at/david/puppet/doc/ for a current version of the RDoc output.
Diffstat (limited to 'plugins/puppet/parser/functions/split.rb')
-rw-r--r--plugins/puppet/parser/functions/split.rb12
1 files changed, 9 insertions, 3 deletions
diff --git a/plugins/puppet/parser/functions/split.rb b/plugins/puppet/parser/functions/split.rb
index 5237c92..bffecc1 100644
--- a/plugins/puppet/parser/functions/split.rb
+++ b/plugins/puppet/parser/functions/split.rb
@@ -1,9 +1,15 @@
-# split($string, $delimiter) : $string
-# split($string[], $delimiter) : $string[][]
+# This function has two modes of operation:
#
-# Split the first argument(s) on every $delimiter. $delimiter is interpreted as
+# split($string, $delimiter) : $string
+#
+# Split the first argument on every $delimiter. $delimiter is interpreted as
# Ruby regular expression.
#
+# split($string[], $delimiter) : $string[][]
+#
+# Returns an array of split results with the result of applying split to each
+# item from the first argument.
+#
# For long-term portability it is recommended to refrain from using Ruby's
# extended RE features.
module Puppet::Parser::Functions