Fix after review

Author: Daniel Carabas

REFERENCE.md

@@ -248,7 +248,7 @@ Default value: `undef`
 
 Data type: `Any`
 
-
+Scipt path for the connection validation check.
 
 Default value: `undef`
 
@@ -312,7 +312,7 @@ Default value: `undef`
 
 Data type: `Any`
 
-
+Default connection settings.
 
 Default value: {}
 
@@ -377,7 +377,6 @@ Default value: `undef`
 Data type: `Any`
 
 Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system.
-Default value: 'postgres'.
 
 Default value: `undef`
 
@@ -466,23 +465,23 @@ Default value: `undef`
 
 Data type: `Any`
 
-
+Allow Puppet to manage the pg_hba.conf file.
 
 Default value: `undef`
 
 ##### `manage_pg_ident_conf`
 
 Data type: `Any`
 
-
+Allow Puppet to manage the pg_ident.conf file.
 
 Default value: `undef`
 
 ##### `manage_recovery_conf`
 
 Data type: `Any`
 
-
+Allow Puppet to manage the recovery.conf file.
 
 Default value: `undef`
 
@@ -1059,7 +1058,7 @@ Default value: $postgresql::params::contrib_package_name
 
 Data type: `String[1]`
 
-Enum['present','absent']. Defaults to 'present'.
+Enum['present','absent'].
 
 Default value: 'present'
 
@@ -1123,15 +1122,15 @@ The following parameters are available in the `postgresql::server::postgis` clas
 
 Data type: `String`
 
-
+Sets the package name.
 
 Default value: $postgresql::params::postgis_package_name
 
 ##### `package_ensure`
 
 Data type: `String[1]`
 
-
+Specifies if the package is present or not.
 
 Default value: 'present'
 
@@ -1181,7 +1180,7 @@ The following parameters are available in the `postgresql::server::database` def
 
 Data type: `Any`
 
-
+Sets a comment on the database.
 
 Default value: `undef`
 
@@ -1245,7 +1244,7 @@ Default value: `false`
 
 Data type: `Any`
 
-
+Specifies a hash of environment variables used when connecting to a remote server.
 
 Default value: $postgresql::server::default_connect_settings
 
@@ -1470,7 +1469,7 @@ Default value: `undef`
 
 Data type: `Any`
 
-
+Specifies a hash of environment variables used when connecting to a remote server.
 
 Default value: $postgresql::server::default_connect_settings
 
@@ -2015,15 +2014,15 @@ Default value: `false`
 
 Data type: `Any`
 
-
+Database used to connect to.
 
 Default value: $postgresql::server::default_database
 
 ##### `port`
 
 Data type: `Any`
 
-
+Port to use when connecting.
 
 Default value: `undef`
 
@@ -2139,7 +2138,7 @@ Default value: $title
 
 Data type: `Any`
 
-
+Specifies a hash of environment variables used when connecting to a remote server.
 
 Default value: $postgresql::server::default_connect_settings
 
@@ -2187,7 +2186,7 @@ Default value: `undef`
 
 Data type: `Any`
 
-
+Port to use when connecting.
 
 Default value: `undef`
 
@@ -2257,7 +2256,7 @@ Default value: $title
 
 Data type: `Any`
 
-
+Specifies a hash of environment variables used when connecting to a remote server.
 
 Default value: $postgresql::server::default_connect_settings
 
@@ -2493,11 +2492,17 @@ An arbitrary tag for your own reference; the name of the message.
 
 ##### `unless`
 
-Optional SQL command to execute before the main command
+An optional SQL command to execute prior to the main :command;
+this is generally intended to be used for idempotency, to check
+for the existence of an object in the database to determine whether
+or not the main SQL command needs to be executed at all.'
 
 ##### `onlyif`
 
-Optional SQL command executed before the main command - return true if matching row found
+An optional SQL command to execute prior to the main :command;
+this is generally intended to be used for idempotency, to check
+for the existence of an object in the database to determine whether
+or not the main SQL command needs to be executed at all.
 
 ##### `connect_settings`
 

lib/puppet/type/postgresql_psql.rb

@@ -26,12 +26,12 @@ def sync
   end
 
   newparam(:unless) do
-    desc 'Optional SQL command to execute before the main command'
-
-    desc 'An optional SQL command to execute prior to the main :command; ' \
-         'this is generally intended to be used for idempotency, to check ' \
-         'for the existence of an object in the database to determine whether ' \
-         'or not the main SQL command needs to be executed at all.'
+    desc <<-DOC
+         An optional SQL command to execute prior to the main :command;
+         this is generally intended to be used for idempotency, to check
+         for the existence of an object in the database to determine whether
+         or not the main SQL command needs to be executed at all.'
+    DOC
 
     # Return true if a matching row is found
     def matches(value)
@@ -47,12 +47,12 @@ def matches(value)
   end
 
   newparam(:onlyif) do
-    desc 'Optional SQL command executed before the main command - return true if matching row found'
-
-    desc 'An optional SQL command to execute prior to the main :command; ' \
-         'this is generally intended to be used for idempotency, to check ' \
-         'for the existence of an object in the database to determine whether ' \
-         'or not the main SQL command needs to be executed at all.'
+    desc <<-DOC
+         An optional SQL command to execute prior to the main :command;
+         this is generally intended to be used for idempotency, to check
+         for the existence of an object in the database to determine whether
+         or not the main SQL command needs to be executed at all.
+    DOC
 
     # Return true if a matching row is found
     def matches(value)

manifests/client.pp

@@ -5,17 +5,12 @@
 #
 # @param file_ensure
 #   Enum['file','absent'].
-# 
 # @param validcon_script_path
 #   Optional. Absolute path for the postgresql connection validation script.
-#
 # @param package_name
 #   String. Sets the name of the PostgreSQL client package.
-#
 # @param package_ensure 
 #   Enum['present','absent'].
-#
-#
 class postgresql::client (
   Enum['file', 'absent'] $file_ensure        = 'file',
   Stdlib::Absolutepath $validcon_script_path = $postgresql::params::validcon_script_path,

manifests/globals.pp

@@ -22,7 +22,7 @@
 # @param service_status Overrides the default status check command for your PostgreSQL service.
 # @param default_database Specifies the name of the default database to connect with.
 #
-# @param validcon_script_path     
+# @param validcon_script_path Scipt path for the connection validation check.
 #
 # @param initdb_path Path to the initdb command.
 # @param createdb_path Deprecated. Path to the createdb command.
@@ -31,7 +31,7 @@
 # @param pg_ident_conf_path Specifies the path to your pg_ident.conf file.
 # @param postgresql_conf_path Sets the path to your postgresql.conf file.
 # @param recovery_conf_path Path to your recovery.conf file.
-# @param default_connect_settings
+# @param default_connect_settings Default connection settings. 
 #
 # @param pg_hba_conf_defaults Disables the defaults supplied with the module for pg_hba.conf if set to false. This is useful if you want to override the defaults. Be sure that your changes align with the rest of the module, as some access is required to perform some operations, such as basic psql operations.    
 #
@@ -47,7 +47,6 @@
 # @param log_line_prefix Overrides the default PostgreSQL log prefix.          
 #
 # @param user Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system.
-#  Default value: 'postgres'.                    
 # @param group Overrides the default postgres user group to be used for related files in the file system.
 #
 # @param version The version of PostgreSQL to install and manage.                 
@@ -68,9 +67,9 @@
 #         
 # @param timezone Sets the default timezone of the postgresql server. The postgresql built-in default is taking the systems timezone information.
 #
-# @param manage_pg_hba_conf       
-# @param manage_pg_ident_conf     
-# @param manage_recovery_conf     
+# @param manage_pg_hba_conf Allow Puppet to manage the pg_hba.conf file.
+# @param manage_pg_ident_conf Allow Puppet to manage the pg_ident.conf file.
+# @param manage_recovery_conf Allow Puppet to manage the recovery.conf file.
 #
 # @param manage_package_repo Sets up official PostgreSQL repositories on your host if set to true.
 # @param module_workdir Specifies working directory under which the psql command should be executed. May need to specify if '/tmp' is on volume mounted with noexec option.

manifests/server/contrib.pp

@@ -3,9 +3,7 @@
 # @param package_name
 #   String. The name of the PostgreSQL contrib package.
 # @param package_ensure
-#   Enum['present','absent']. Defaults to 'present'.
-# 
-#
+#   Enum['present','absent'].
 class postgresql::server::contrib (
   String $package_name      = $postgresql::params::contrib_package_name,
   String[1] $package_ensure = 'present'

manifests/server/database.pp

@@ -1,15 +1,14 @@
 # @summary Define for creating a database.
 #
-# @param comment 
+# @param comment Sets a comment on the database.
 # @param dbname Sets the name of the database.
 # @param owner Sets name of the database owner.
 # @param tablespace Sets tablespace for where to create this database.
 # @param template Specifies the name of the template database from which to build this database. Default value: 'template0'.
 # @param encoding Overrides the character set during creation of the database.
 # @param locale Overrides the locale during creation of the database.
 # @param istemplate Defines the database as a template if set to true.
-# @param connect_settings
-#
+# @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
 define postgresql::server::database(
   $comment          = undef,
   $dbname           = $title,

manifests/server/database_grant.pp

@@ -7,7 +7,6 @@
 # @param psql_db Defines the database to execute the grant against. This should not ordinarily be changed from the default
 # @param psql_user Specifies the OS user for running psql. Default value: The default user for the module, usually 'postgres'.
 # @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
-#
 define postgresql::server::database_grant(
   $privilege,
   $db,

manifests/server/db.pp

@@ -11,8 +11,6 @@
 # @param template Specifies the name of the template database from which to build this database. Defaults value: template0.
 # @param istemplate Specifies that the database is a template, if set to true.
 # @param owner Sets a user as the owner of the database.
-#
-#
 define postgresql::server::db (
   $user,
   $password,

manifests/server/extension.pp

@@ -13,8 +13,7 @@
 # @param ensure Specifies whether to activate or deactivate the extension. Valid options: 'present' or 'absent'.
 # @param package_name Specifies a package to install prior to activating the extension.
 # @param package_ensure Overrides default package deletion behavior. By default, the package specified with package_name is installed when the extension is activated and removed when the extension is deactivated. To override this behavior, set the ensure value for the package.
-# @param connect_settings 
-#
+# @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
 define postgresql::server::extension (
   $database,
   $extension                   = $name,

manifests/server/grant.pp

@@ -11,7 +11,6 @@
 # @param onlyif_exists
 # @param connect_settings
 # @param ensure Specifies whether to grant or revoke the privilege. Default is to grant the privilege. Valid values: 'present', 'absent'.
-#
 define postgresql::server::grant (
   String $role,
   String $db,

manifests/server/grant_role.pp

@@ -7,7 +7,6 @@
 # @param psql_user Sets the OS user to run psql.
 # @param port Port to use when connecting.
 # @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
-#
 define postgresql::server::grant_role (
   String[1] $group,
   String[1] $role                   = $name,

manifests/server/pg_hba_rule.pp

@@ -11,7 +11,6 @@
 # @param order Sets an order for placing the rule in pg_hba.conf. This can be either a string or an integer. If it is an integer, it will be converted to a string by zero-padding it to three digits. E.g. 42 will be zero-padded to the string '042'. The pg_hba_rule fragments are sorted using the alpha sorting order. Default value: 150.
 # @param target Provides the target for the rule, and is generally an internal only property. Use with caution.
 # @param postgresql_version Manages pg_hba.conf without managing the entire PostgreSQL instance.
-#
 define postgresql::server::pg_hba_rule(
   Enum['local', 'host', 'hostssl', 'hostnossl'] $type,
   String $database,

manifests/server/pg_ident_rule.pp

@@ -6,7 +6,6 @@
 # @param description Sets a longer description for this rule if required. This description is placed in the comments above the rule in pg_ident.conf. Default value: 'none'.
 # @param order Defines an order for placing the mapping in pg_ident.conf. Default value: 150.
 # @param target Provides the target for the rule and is generally an internal only property. Use with caution.
-#
 define postgresql::server::pg_ident_rule(
   $map_name,
   $system_username,

manifests/server/plperl.pp

@@ -2,7 +2,6 @@
 # 
 # @param package_ensure The ensure parameter passed on to PostgreSQL PL/Perl package resource.
 # @param package_name The name of the PostgreSQL PL/Perl package.
-#
 class postgresql::server::plperl(
   $package_ensure = 'present',
   $package_name   = $postgresql::server::plperl_package_name

manifests/server/plpython.pp

@@ -4,7 +4,6 @@
 #   Enum['present','absent']. Specifies whether the package is present.
 # @param package_name
 #   Specifies the name of the postgresql PL/Python package.
-#
 class postgresql::server::plpython(
   $package_ensure = 'present',
   $package_name   = $postgresql::server::plpython_package_name,

manifests/server/postgis.pp

@@ -1,8 +1,7 @@
 # @summary Install the postgis postgresql packaging.
 #
-# @param package_name
-# @param package_ensure
-#
+# @param package_name Sets the package name.
+# @param package_ensure Specifies if the package is present or not.
 class postgresql::server::postgis (
   String $package_name      = $postgresql::params::postgis_package_name,
   String[1] $package_ensure = 'present'

manifests/server/reassign_owned_by.pp

@@ -8,7 +8,6 @@
 # @param psql_user Specifies the OS user for running psql.
 # @param port Port to use when connecting.
 # @param connect_settings Specifies a hash of environment variables used when connecting to a remote server.
-#
 define postgresql::server::reassign_owned_by (
   String $old_role,
   String $new_role,