Convert classes to puppet-strings #617
Conversation
manifests/check.pp
Outdated
| # @summary Sets up a Consul healthcheck | ||
| # @see http://www.consul.io/docs/agent/checks.html | ||
| # | ||
| # @param ensure Define availability of check. Use 'absent' to remove existing checks. Defaults to 'present' |
There was a problem hiding this comment.
Do you not prefer the style where the description is on the line below? (Also you can leave out Defaults to 'present' here as puppet-strings will produce that information itself).
There was a problem hiding this comment.
I removed the defaults mentions. My personal preference is to have it in a single line, and my guess is that we've a slight majority of modules with that style. But I can live with multiline as well.
There was a problem hiding this comment.
maybe that's something for our styleguide 🤔
There was a problem hiding this comment.
My preference is the opposite :)
The upstream styleguide says use either, but presumably the author preferred the indented description style as that's used in all the examples.
Pull Request (PR) description
This Pull Request (PR) fixes the following issues