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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/is_string.rb b/3rdparty/modules/stdlib/lib/puppet/functions/is_string.rb
index a32216c05..a112efdd3 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/is_string.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/is_string.rb
@@ -1,4 +1,14 @@
+# @summary
+#   Wrapper that calls the Puppet 3.x funtion of the same name.
 Puppet::Functions.create_function(:is_string) do
+  # @param scope
+  #   The main value that will be passed to the wrapped method
+  #
+  # @param args
+  #   Any additional values that are to be passed to the wrapped method
+  #
+  # @return [Boolean]
+  #   A boolean value returned from the called 3.x function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args