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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_hash.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_hash.rb
index ad907f086..f85b9eeaa 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_hash.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_hash.rb
@@ -1,15 +1,20 @@
 #
 # is_hash.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_hash, :type => :rvalue, :doc => <<-EOS
-Returns true if the variable passed to this function is a hash.
-    EOS
-  ) do |arguments|
+  newfunction(:is_hash, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the variable passed to this function is a hash.
+
+    @return [Boolean]
+      Returns `true` or `false`
+
+    > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+    [`validate_legacy`](#validate_legacy).
+    DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "is_hash(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size != 1
+    raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     type = arguments[0]