Merge pull request #218 from traylenator/render

Render post_transaction_action examples correctly
voxpupuli · Jul 6, 2021 · fbda272 · fbda272
2 parents 09cc4d1 + 0da0ff8
commit fbda272
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 27 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -225,9 +225,7 @@ A $(yum clean all) Exec to be notified if desired.
 
 ### <a name="yumpluginpost_transaction_actions"></a>`yum::plugin::post_transaction_actions`
 
-class{'yum::plugin::post_transaction_actions':
-  ensure => present,
-}
+Class to install post_transaction plugin
 
 * **See also**
   * https://dnf-plugins-core.readthedocs.io/en/latest/post-transaction-actions.html
@@ -238,7 +236,9 @@ class{'yum::plugin::post_transaction_actions':
 ##### Enable post_transaction_action plugin
 
 ```puppet
-
+class{'yum::plugin::post_transaction_actions':
+  ensure => present,
+}
 ```
 
 #### Parameters
@@ -611,11 +611,7 @@ Default value: ``undef``
 
 ### <a name="yumpost_transaction_action"></a>`yum::post_transaction_action`
 
-yum::post_transaction_action{'touch file on ssh package update':
-  key     => 'openssh-*',
-  state   => 'any',
-  command => 'touch /tmp/openssh-installed',
-}
+Creates post transaction configuratons for dnf or yum.
 
 * **See also**
   * https://dnf-plugins-core.readthedocs.io/en/latest/post-transaction-actions.html
@@ -626,7 +622,11 @@ yum::post_transaction_action{'touch file on ssh package update':
 ##### Touch a file when ssh is package is updated, installed or removed.
 
 ```puppet
-
+yum::post_transaction_action{'touch file on ssh package update':
+  key     => 'openssh-*',
+  state   => 'any',
+  command => 'touch /tmp/openssh-installed',
+}
 ```
 
 #### Parameters
@@ -636,7 +636,6 @@ The following parameters are available in the `yum::post_transaction_action` def
 * [`action`](#action)
 * [`key`](#key)
 * [`state`](#state)
-* [`action`](#action)
 * [`command`](#command)
 
 ##### <a name="action"></a>`action`
@@ -662,17 +661,11 @@ Can be `in`, `out` or `any` on DNF based systems.
 
 Default value: `'any'`
 
-##### <a name="action"></a>`action`
-
-The command to run
-
-Default value: `$title`
-
 ##### <a name="command"></a>`command`
 
 Data type: `String[1]`
 
-
+The command to run
 
 ### <a name="yumversionlock"></a>`yum::versionlock`
 

diff --git a/manifests/plugin/post_transaction_actions.pp b/manifests/plugin/post_transaction_actions.pp
@@ -5,9 +5,9 @@
 # @param ensure Should the post_transaction actions plugin be installed
 #
 # @example Enable post_transaction_action plugin
-# class{'yum::plugin::post_transaction_actions':
-#   ensure => present,
-# }
+#   class{'yum::plugin::post_transaction_actions':
+#     ensure => present,
+#   }
 #
 class yum::plugin::post_transaction_actions (
   Enum['present', 'absent'] $ensure = 'present',

diff --git a/manifests/post_transaction_action.pp b/manifests/post_transaction_action.pp
@@ -7,14 +7,14 @@
 # @param state
 #    Can be `install`, `update`, `remove` or `any` on YUM based systems.
 #    Can be `in`, `out` or `any` on DNF based systems.
-# @param action The command to run
+# @param command The command to run
 #
 # @example Touch a file when ssh is package is updated, installed or removed.
-# yum::post_transaction_action{'touch file on ssh package update':
-#   key     => 'openssh-*',
-#   state   => 'any',
-#   command => 'touch /tmp/openssh-installed',
-# }
+#   yum::post_transaction_action{'touch file on ssh package update':
+#     key     => 'openssh-*',
+#     state   => 'any',
+#     command => 'touch /tmp/openssh-installed',
+#   }
 #
 define yum::post_transaction_action (
   Variant[Enum['*'],Yum::RpmNameGlob,Stdlib::Unixpath] $key,