Skip to content

Commit

Permalink
fix trailing spaces
Browse files Browse the repository at this point in the history
@example tag requires a description, otherwise puppet-strings leaves trailing spaces
  • Loading branch information
vchepkov committed Dec 7, 2023
1 parent 4cd472f commit fd75f75
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
11 changes: 5 additions & 6 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ converts two arrays into hash

#### Examples

#####
##### Using function

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

##### Examples

######
###### Using function

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

#### Examples

#####
##### Using function

```puppet
peadm::determine_status($data, true)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -2030,7 +2030,7 @@ Return status information from one or more PE clusters in a table format

#### Examples

#####
##### Using plan

```puppet
peadm::status($targets, 'table', true, true)
Expand Down Expand Up @@ -2276,4 +2276,3 @@ Optional[Enum[


Default value: `undef`

4 changes: 2 additions & 2 deletions functions/convert_hash.pp
Original file line number Diff line number Diff line change
@@ -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 }
Expand Down
2 changes: 1 addition & 1 deletion functions/determine_status.pp
Original file line number Diff line number Diff line change
Expand Up @@ -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" => {
Expand Down
4 changes: 2 additions & 2 deletions plans/status.pp
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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()
Expand Down

0 comments on commit fd75f75

Please sign in to comment.