summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/zip.rb
diff options
context:
space:
mode:
authorKen Barber <ken@bob.sh>2011-07-29 22:18:56 +0100
committerKen Barber <ken@bob.sh>2011-07-29 22:18:56 +0100
commit19313b43ea04066a88a0b78e83650ac52785e2e9 (patch)
tree15c8e5de95a4ffa297683a1bdab0d45a1bfb97eb /lib/puppet/parser/functions/zip.rb
parentf9634b7f9b03be86e25dc740cdcda754a0d2bf7d (diff)
(#3) Apply missing documentation to more functions.
Diffstat (limited to 'lib/puppet/parser/functions/zip.rb')
-rw-r--r--lib/puppet/parser/functions/zip.rb9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb
index 024d64a..2b56e9c 100644
--- a/lib/puppet/parser/functions/zip.rb
+++ b/lib/puppet/parser/functions/zip.rb
@@ -4,6 +4,15 @@
module Puppet::Parser::Functions
newfunction(:zip, :type => :rvalue, :doc => <<-EOS
+Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments.
+
+*Example:*
+
+ zip(['1','2','3'],['4','5','6'])
+
+Would result in:
+
+ ["1", "4"], ["2", "5"], ["3", "6"]
EOS
) do |arguments|