Skip to content

Commit dd0f740

Browse files
committed
fix trailing spaces
@example tag requires a description, otherwise puppet-strings leaves trailing spaces
1 parent 4cd472f commit dd0f740

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

REFERENCE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ converts two arrays into hash
324324

325325
#### Examples
326326

327-
#####
327+
##### Using function
328328

329329
```puppet
330330
peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
@@ -341,7 +341,7 @@ Returns: `Array`
341341

342342
##### Examples
343343

344-
######
344+
###### Using function
345345

346346
```puppet
347347
peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
@@ -465,7 +465,7 @@ Type: Puppet Language
465465

466466
#### Examples
467467

468-
#####
468+
##### Using function
469469

470470
```puppet
471471
peadm::determine_status($data, true)
@@ -519,7 +519,7 @@ Returns: `Hash` A simplified hash of of status data for the given stack
519519

520520
##### Examples
521521

522-
######
522+
###### Using function
523523

524524
```puppet
525525
peadm::determine_status($data, true)
@@ -2030,7 +2030,7 @@ Return status information from one or more PE clusters in a table format
20302030

20312031
#### Examples
20322032

2033-
#####
2033+
##### Using plan
20342034

20352035
```puppet
20362036
peadm::status($targets, 'table', true, true)

functions/convert_hash.pp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# @summary converts two arrays into hash
1+
# @summary converts two arrays into hash
22
# @param keys an array of key names to be merged into the hash
33
# @param values data to be merged into an array with the keys
4-
# @example
4+
# @example Using function
55
# peadm::convert_hash(['type', 'status'], [['xl', 'running'], ['large', 'failed']])
66
# [
77
# { type => xl, status => running}, { type => large, status => failed }

functions/determine_status.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# @param status_data Raw json data as returned by puppet infra status --format=json
33
# @param use_colors Adds colors to the status, defaults to true
44
# @return A simplified hash of of status data for the given stack
5-
# @example
5+
# @example Using function
66
# peadm::determine_status($data, true)
77
# {
88
# "failed" => {

plans/status.pp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# @param summarize Controls the type of json output to render, defaults to true
66
# @param verbose Toggles the output to show all the operationally services, can be loads more data
77
# @param colors Toggles the usage of colors, you may want to disable if the format is json
8-
# @example
8+
# @example Using plan
99
# peadm::status($targets, 'table', true, true)
1010
plan peadm::status(
1111
TargetSpec $targets,
@@ -17,7 +17,7 @@
1717
peadm::assert_supported_bolt_version()
1818

1919
$results = run_task('peadm::infrastatus', $targets, { format => 'json' })
20-
# returns the data in a hash
20+
# returns the data in a hash
2121
$stack_status = $results.reduce({}) | $res, $item | {
2222
$data = $item.value[output]
2323
$stack_name = $item.target.peadm::certname()

0 commit comments

Comments
 (0)