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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_bool.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_bool.rb
index 2ebe430cd..cf5cb32c0 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_bool.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_bool.rb
@@ -1,14 +1,21 @@
 #
 # is_bool.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS
-Returns true if the variable passed to this function is a boolean.
-    EOS
-  ) do |arguments|
+  newfunction(:is_bool, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the variable passed to this function is a boolean.
+
+    @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|
 
-    function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.'])
+    function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function,
+                          with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.'])
 
     raise(Puppet::ParseError, "is_bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1