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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/keys.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/keys.rb
index f0d13b647..80d080c65 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/keys.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/keys.rb
@@ -1,15 +1,20 @@
 #
 # keys.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:keys, :type => :rvalue, :doc => <<-EOS
-Returns the keys of a hash as an array.
-    EOS
-  ) do |arguments|
+  newfunction(:keys, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns the keys of a hash as an array.
+
+    @return [Array]
+      An array containing each of the hashes key values.
+
+    > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys)
+    function will be used instead of this function.
+    DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "keys(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+    raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     hash = arguments[0]