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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_key.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_key.rb
index 4657cc29c..50dde53e3 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_key.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_key.rb
@@ -1,28 +1,39 @@
+#
+# has_key.rb
+#
 module Puppet::Parser::Functions
+  newfunction(:has_key, :type => :rvalue, :doc => <<-'DOC') do |args|
+    @summary
+      **Deprecated:** Determine if a hash has a certain key value.
 
-  newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args|
-    Determine if a hash has a certain key value.
+    @return
+      Boolean value
 
-    Example:
+    @example Example Usage:
 
-        $my_hash = {'key_one' => 'value_one'}
-        if has_key($my_hash, 'key_two') {
-          notice('we will not reach here')
-        }
-        if has_key($my_hash, 'key_one') {
-          notice('this will be printed')
-        }
+      $my_hash = {'key_one' => 'value_one'}
+      if has_key($my_hash, 'key_two') {
+        notice('we will not reach here')
+      }
+      if has_key($my_hash, 'key_one') {
+        notice('this will be printed')
+      }
 
-    ENDHEREDOC
+    > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet
+    language with the following equivalent expression:
+    $my_hash = {'key_one' => 'value_one'}
+    if 'key_one' in $my_hash {
+      notice('this will be printed')
+    }
+
+    DOC
 
     unless args.length == 2
-      raise Puppet::ParseError, ("has_key(): wrong number of arguments (#{args.length}; must be 2)")
+      raise Puppet::ParseError, "has_key(): wrong number of arguments (#{args.length}; must be 2)"
     end
     unless args[0].is_a?(Hash)
       raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}"
     end
-    args[0].has_key?(args[1])
-
+    args[0].key?(args[1])
   end
-
 end