summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/flatten.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/flatten.rb')
-rw-r--r--lib/puppet/parser/functions/flatten.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb
index 6036f72..781da78 100644
--- a/lib/puppet/parser/functions/flatten.rb
+++ b/lib/puppet/parser/functions/flatten.rb
@@ -4,6 +4,14 @@
module Puppet::Parser::Functions
newfunction(:flatten, :type => :rvalue, :doc => <<-EOS
+This function flattens any deeply nested arrays and returns a single flat array
+as a result.
+
+*Examples:*
+
+ flatten(['a', ['b', ['c']]])
+
+Would return: ['a','b','c']
EOS
) do |arguments|