Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / functions / type_of.rb
index 02cdd4d..e745659 100644 (file)
@@ -1,4 +1,5 @@
-# Returns the type when passed a value.
+# @summary
+#   Returns the type of the passed value.
 #
 # @example how to compare values' types
 #   # compare the types of two values
 # See the documentation for "The Puppet Type System" for more information about types.
 # See the `assert_type()` function for flexible ways to assert the type of a value.
 #
+# The built-in type() function in puppet is generally preferred over this function
+# this function is provided for backwards compatibility.
 Puppet::Functions.create_function(:type_of) do
+  # @return [String]
+  #   the type of the passed value
+  #
+  # @param value
   def type_of(value)
     Puppet::Pops::Types::TypeCalculator.infer_set(value)
   end