From de7690c4e76ddd7c1f01d81fe92c75771da47c51 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 9 Jun 2009 17:51:10 +0200 Subject: RDoc-ify documentation See http://club.black.co.at/david/puppet/doc/ for a current version of the RDoc output. --- plugins/puppet/parser/functions/split.rb | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'plugins/puppet/parser/functions/split.rb') 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 -- cgit v1.2.3