X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fhash.rb;h=484cb59bfaeb45cb5d3669af3db665a90a9817fa;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=22763f311a5183158329ef4337875c60083007c7;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/hash.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/hash.rb
index 22763f311..484cb59bf 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/hash.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/hash.rb
@@ -1,20 +1,28 @@
 #
 # hash.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:hash, :type => :rvalue, :doc => <<-EOS
-This function converts an array into a hash.
-
-*Examples:*
-
-    hash(['a',1,'b',2,'c',3])
-
-Would return: {'a'=>1,'b'=>2,'c'=>3}
-    EOS
-  ) do |arguments|
-
-    raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+  newfunction(:hash, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** This function converts an array into a hash.
+
+    @return
+      the converted array as a hash
+    @example Example Usage:
+      hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}
+
+    > **Note:** This function has been replaced with the built-in ability to create a new value of almost any
+    data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function
+    in Puppet.
+    This example shows the equivalent expression in the Puppet language:
+      ```
+      Hash(['a',1,'b',2,'c',3])
+      Hash([['a',1],['b',2],['c',3]])
+      ```
+    DOC
+             ) do |arguments|
+
+    raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     array = arguments[0]