Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / functions / os_version_gte.rb
index e3089a8..7ab095e 100644 (file)
@@ -1,11 +1,16 @@
-# Checks if the OS version is at least a certain version. Note that only the
-# major version is taken into account.
-#
-# Example usage:
+# @summary
+#   Checks if the OS version is at least a certain version.
+# > *Note:*
+# Only the major version is taken into account.
 #
+# @example Example usage:#
 #     if os_version_gte('Debian', '9') { }
 #     if os_version_gte('Ubuntu', '18.04') { }
 Puppet::Functions.create_function(:os_version_gte) do
+  # @param os operating system
+  # @param version
+  #
+  # @return [Boolean] `true` or `false
   dispatch :os_version_gte do
     param 'String[1]', :os
     param 'String[1]', :version