Merge pull request #412 from vchepkov/fix-examples

fix trailing spaces
puppetlabs · Dec 12, 2023 · 770f8a1 · 770f8a1
2 parents 85ef95f + dd0f740
commit 770f8a1
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -324,7 +324,7 @@ converts two arrays into hash
 
 #### Examples
 
-##### 
+##### Using function
 
 ```puppet
 peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
@@ -341,7 +341,7 @@ Returns: `Array`
 
 ##### Examples
 
-###### 
+###### Using function
 
 ```puppet
 peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
@@ -465,7 +465,7 @@ Type: Puppet Language
 
 #### Examples
 
-##### 
+##### Using function
 
 ```puppet
 peadm::determine_status($data, true)
@@ -519,7 +519,7 @@ Returns: `Hash` A simplified hash of of status data for the given stack
 
 ##### Examples
 
-###### 
+###### Using function
 
 ```puppet
 peadm::determine_status($data, true)
@@ -2036,7 +2036,7 @@ Return status information from one or more PE clusters in a table format
 
 #### Examples
 
-##### 
+##### Using plan
 
 ```puppet
 peadm::status($targets, 'table', true, true)

diff --git a/functions/convert_hash.pp b/functions/convert_hash.pp
@@ -1,7 +1,7 @@
-# @summary converts two arrays into hash 
+# @summary converts two arrays into hash
 # @param keys an array of key names to be merged into the hash
 # @param values data to be merged into an array with the keys
-# @example 
+# @example Using function
 #   peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
 #   [
 #     { type => xl, status => running}, { type => large, status => failed }

diff --git a/functions/determine_status.pp b/functions/determine_status.pp
@@ -2,7 +2,7 @@
 # @param status_data Raw json data as returned by puppet infra status --format=json
 # @param use_colors Adds colors to the status, defaults to true
 # @return A simplified hash of of status data for the given stack
-# @example 
+# @example Using function
 #  peadm::determine_status($data, true)
 #  {
 #   "failed" => {

diff --git a/plans/status.pp b/plans/status.pp
@@ -5,7 +5,7 @@
 # @param summarize Controls the type of json output to render, defaults to true
 # @param verbose Toggles the output to show all the operationally services, can be loads more data
 # @param colors Toggles the usage of colors, you may want to disable if the format is json
-# @example 
+# @example Using plan
 #   peadm::status($targets, 'table', true, true)
 plan peadm::status(
   TargetSpec $targets,
@@ -17,7 +17,7 @@
   peadm::assert_supported_bolt_version()
 
   $results = run_task('peadm::infrastatus', $targets, { format => 'json' })
-  # returns the data in a hash 
+  # returns the data in a hash
   $stack_status = $results.reduce({}) | $res, $item | {
     $data = $item.value[output]
     $stack_name = $item.target.peadm::certname()