X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Ffunctions%2Fvalidate_numeric.rb;h=f98fa7463f98f4bd7fc9e6a1cd6cb8d22c63f3c0;hp=3adb0a87bdee04d3e25ae1085fe31b0a95d54e25;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_numeric.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_numeric.rb
index 3adb0a87b..f98fa7463 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_numeric.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_numeric.rb
@@ -1,4 +1,14 @@
+# @summary
+#   Validate the passed value represents a numeric value.
 Puppet::Functions.create_function(:validate_numeric) 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