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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/length.rb b/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
index ccd662a16..9a163deaf 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
@@ -1,10 +1,18 @@
-# A function to eventually replace the old size() function for stdlib
-# The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution.
+# @summary
+#   **Deprecated:** A function to eventually replace the old size() function for stdlib
 #
-# Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core
-# will be used instead of this function.
+# The original size() function did not handle Puppets new type capabilities, so this function
+# is a Puppet 4 compatible solution.
+#
+# > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+# built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function.
 #
 Puppet::Functions.create_function(:length) do
+  # @param value
+  #   The value whose length is to be found
+  #
+  # @return [Integer]
+  #   The length of the given object
   dispatch :length do
     param 'Variant[String,Array,Hash]', :value
   end