Merge pull request puppetlabs#1075 from carabasdaniel/strings

[FM-7936] Puppet Strings

Author: eimlav

README.md

@@ -5,7 +5,7 @@ module Puppet::Parser::Functions
     suitable for create_resources. It is not intended to be used outside of the
     postgresql internal classes/defined resources.
 
-    This function accepts an array of strings that are pg_hba.conf rules. It
+    @return This function accepts an array of strings that are pg_hba.conf rules. It
     will return a hash that can be fed into create_resources to create multiple
     individual pg_hba_rule resources.
 

REFERENCE.md

@@ -3,7 +3,8 @@
 # postgresql_escape.rb
 module Puppet::Parser::Functions
   newfunction(:postgresql_escape, type: :rvalue, doc: <<-EOS
-    Safely escapes a string using $$ using a random tag which should be consistent
+    This function safely escapes a string using a consistent random tag
+    @return Safely escapes a string using $$ using a random tag which should be consistent
     EOS
              ) do |args|
 

lib/puppet/parser/functions/postgresql_acls_to_resources_hash.rb

@@ -4,7 +4,8 @@
 # postgresql_password.rb
 module Puppet::Parser::Functions
   newfunction(:postgresql_password, type: :rvalue, doc: <<-EOS
-    Returns the postgresql password hash from the clear text username / password.
+    This function returns the postgresql password hash from the clear text username / password
+    @return Returns the postgresql password hash from the clear text username / password.
     EOS
              ) do |args|
 

lib/puppet/parser/functions/postgresql_escape.rb

@@ -1,4 +1,5 @@
 Puppet::Type.type(:postgresql_psql).provide(:ruby) do
+  desc 'Postgres psql provider'
   def run_unless_sql_command(sql)
     # for the 'unless' queries, we wrap the user's query in a 'SELECT COUNT',
     # which makes it easier to parse and process the output.

lib/puppet/parser/functions/postgresql_password.rb

@@ -1,5 +1,5 @@
 Puppet::Type.type(:postgresql_replication_slot).provide(:ruby) do
-  # For confinement
+  desc 'For confinement'
   commands psql: 'psql'
 
   def self.instances

lib/puppet/provider/postgresql_psql/ruby.rb

@@ -1,11 +1,16 @@
 Puppet::Type.newtype(:postgresql_conn_validator) do
-  @doc = "Verify that a connection can be successfully established between a node
+  @doc = <<-EOS
+          @summary Verify if a connection can be successfully established
+
+          Verify that a connection can be successfully established between a node
           and the PostgreSQL server.  Its primary use is as a precondition to
           prevent configuration changes from being applied if the PostgreSQL
           server cannot be reached, but it could potentially be used for other
-          purposes such as monitoring."
+          purposes such as monitoring.
+  EOS
 
   ensurable do
+    desc 'Ensure connection validation'
     defaultvalues
     defaultto :present
   end

lib/puppet/provider/postgresql_replication_slot/ruby.rb

@@ -26,10 +26,12 @@ def sync
   end
 
   newparam(:unless) do
-    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)
@@ -45,10 +47,12 @@ def matches(value)
   end
 
   newparam(:onlyif) do
-    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)

lib/puppet/type/postgresql_conn_validator.rb

@@ -1,10 +1,11 @@
 Puppet::Type.newtype(:postgresql_replication_slot) do
-  @doc = "Manages Postgresql replication slots.
+  @doc = <<-EOS
+@summary Manages Postgresql replication slots.
 
 This type allows to create and destroy replication slots
 to register warm standby replication on a Postgresql
 master server.
-"
+EOS
 
   ensurable