Merge pull request #1401 from pmcmaw/maint/main/update-minor-docs

(IAC-1430) - Minor docs updating

Author: david22swan

lib/puppet/functions/mysql/normalise_and_deepmerge.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# @summary Recursively merges two or more hashes together, normalises keys with differing use of dashesh and underscores,
-#   then returns the resulting hash.
+# @summary Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores.
 #
 # @example
 #   $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
@@ -15,6 +14,12 @@
 # - When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.
 #
 Puppet::Functions.create_function(:'mysql::normalise_and_deepmerge') do
+  # @param args
+  #   Hash to be normalised
+  #
+  # @return hash
+  #   The given hash normalised
+  #
   def normalise_and_deepmerge(*args)
     if args.length < 2
       raise Puppet::ParseError, _('mysql::normalise_and_deepmerge(): wrong number of arguments (%{args_length}; must be at least 2)') % { args_length: args.length }

manifests/client.pp

@@ -16,10 +16,6 @@
 #   Whether the MySQL package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'.
 # @param package_manage
 #   Whether to manage the MySQL client package. Defaults to `true`.
-# @param service_name
-#   The name of the MySQL server service. Defaults are OS dependent, defined in 'params.pp'.
-# @param service_provider
-#   The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.
 # @param package_name
 #   The name of the MySQL client package to install.
 #

types/options.pp

@@ -1,3 +1,5 @@
+# @summary A hash of options structured like the override_options, but not merged with the default options.
+# Use this if you don’t want your options merged with the default options.
 type Mysql::Options = Hash[
   String,
   Hash,