Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / functions / length.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/length.rb b/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
index 86e735c..9a163de 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/length.rb
@@ -1,14 +1,27 @@
-#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
+#
+# 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
-  def  length(value)
+  def length(value)
     if value.is_a?(String)
       result = value.length
     elsif value.is_a?(Array) || value.is_a?(Hash)
       result = value.size
     end
-    return result
+    result
   end
 end