Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_bool.rb

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 2ebe430..cf5cb32 100644 (file)
--- 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