Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / keys.rb
index 199e319..80d080c 100644 (file)
@@ -1,14 +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]