From 540e2e0571adee17a3170d49c8a5d023e46032de Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Fri, 26 Aug 2022 15:33:38 +0900
Subject: [PATCH] Use standard parameter description format for wsgi::apache

Currently parameter description of the <module>::wsgi::apache classes
are formatted differently in individual modules, and this is making
the maintenance effort quite difficult.

This change updates the description format following the srandard one
we are globally using in our modules to reduce undesired differences
between modules.

Change-Id: I620b9cea87b3bde5777dc8e83e9d8a57440f00b1
---
 manifests/wsgi/apache.pp | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/manifests/wsgi/apache.pp b/manifests/wsgi/apache.pp
index bdc6317e..317e6df2 100644
--- a/manifests/wsgi/apache.pp
+++ b/manifests/wsgi/apache.pp
@@ -19,7 +19,7 @@
 #
 # Install Octavia API under apache with mod_wsgi.
 #
-# == Parameters:
+# == Parameters
 #
 # [*servername*]
 #   (Optional) The servername for the virtualhost.
@@ -38,7 +38,7 @@
 #   Defaults to '/'
 #
 # [*ssl*]
-#   (Optional) Use ssl.
+#   (Optional) Use ssl ? (boolean)
 #   Defaults to false
 #
 # [*workers*]
@@ -65,7 +65,7 @@
 # [*ssl_crl*]
 # [*ssl_certs_dir*]
 #   (Optional) apache::vhost ssl parameters.
-#   Default to apache::vhost 'ssl_*' defaults
+#   Default to apache::vhost 'ssl_*' defaults.
 #
 # [*access_log_file*]
 #   (Optional) The log file name for the virtualhost.
@@ -114,11 +114,11 @@
 #   Defaults to $::octavia::params::octavia_wsgi_script_source
 #
 # [*headers*]
-#   (optional) Headers for the vhost.
+#   (Optional) Headers for the vhost.
 #   Defaults to undef
 #
 # [*request_headers*]
-#   (optional) Modifies collected request headers in various ways.
+#   (Optional) Modifies collected request headers in various ways.
 #   Defaults to undef
 #
 # [*vhost_custom_fragment*]
@@ -126,7 +126,7 @@
 #   directives to be placed at the end of the vhost configuration.
 #   Defaults to undef.
 #
-# == Example:
+# == Examples
 #
 #   include apache
 #   class { 'octavia::wsgi::apache': }