X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Ffunctions%2Fvalidate_bool.rb;h=85892ddad0fcc53857b7c9af58b9c5ebd2a244d8;hb=e04ab5e864ae21d8ea31efb9e7bacf43091f50a3;hp=5cfb2accca24cfcbb367a2e83d69a81ade1f9209;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_bool.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_bool.rb
index 5cfb2accc..85892ddad 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_bool.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_bool.rb
@@ -1,15 +1,28 @@
+# @summary
+#   Validate the passed value represents a boolean.
 Puppet::Functions.create_function(:validate_bool) do
+  # @param scope
+  #   The main value that will be passed to the method
+  #
+  # @param args
+  #   Any additional values that are to be passed to the method
+  #
+  # @return [Boolean] `true` or `false`
+  #   A boolean value returned from the called function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args
   end
-  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
+  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff
+  #   -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
   def call(scope, *args)
     manipulated_args = [scope] + args
     self.class.dispatcher.dispatch(self, scope, manipulated_args)
   end
+
   def deprecation_gen(scope, *args)
-    call_function('deprecation', 'validate_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.")
-    scope.send("function_validate_bool", args)
+    call_function('deprecation', 'validate_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.')
+    scope.send('function_validate_bool', args)
   end
 end