X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fflatten.rb;h=7344201fdf6b92083d69be7eb67a127b1f4a633b;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=a1ed183290127914e65bbed54aa3aae2763086c3;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/flatten.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/flatten.rb
index a1ed18329..7344201fd 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/flatten.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/flatten.rb
@@ -1,22 +1,25 @@
 #
 # flatten.rb
 #
-
 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.
+  newfunction(:flatten, :type => :rvalue, :doc => <<-DOC
+    @summary
+      This function flattens any deeply nested arrays and returns a single flat array
+      as a result.
+
+    @return
+      convert nested arrays into a single flat array
 
-*Examples:*
+    @example Example usage
 
-    flatten(['a', ['b', ['c']]])
+      flatten(['a', ['b', ['c']]])` returns: `['a','b','c']
 
-Would return: ['a','b','c']
-    EOS
-  ) do |arguments|
+    > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a
+    built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function.
+  DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "flatten(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size != 1
+    raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     array = arguments[0]