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_slength.rb;h=aa4143ba9a4968b512acacb241bfff1dba1bc3ed;hp=ad6f7b3adf8b813feed1912daf934735140b171d;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_slength.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_slength.rb
index ad6f7b3ad..aa4143ba9 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_slength.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_slength.rb
@@ -1,4 +1,13 @@
+#  Validate that a passed string has length less/equal with the passed value
 Puppet::Functions.create_function(:validate_slength) 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