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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/os_version_gte.rb b/3rdparty/modules/stdlib/lib/puppet/functions/os_version_gte.rb
index e3089a858..7ab095e82 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/os_version_gte.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/os_version_gte.rb
@@ -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