From 19313b43ea04066a88a0b78e83650ac52785e2e9 Mon Sep 17 00:00:00 2001
From: Ken Barber <ken@bob.sh>
Date: Fri, 29 Jul 2011 22:18:56 +0100
Subject: (#3) Apply missing documentation to more functions.

---
 lib/puppet/parser/functions/zip.rb | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'lib/puppet/parser/functions/zip.rb')

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|
 
-- 
cgit v1.2.3