Fix puppet-strings documentation #1363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ekohl
commented
Aug 23, 2022
| @@ -77,7 +77,7 @@ | |||
| # @param roles Specifies a hash from which to generate postgresql::server::role resources. | |||
| # @param config_entries Specifies a hash from which to generate postgresql::server::config_entry resources. | |||
| # @param pg_hba_rules Specifies a hash from which to generate postgresql::server::pg_hba_rule resources. | |||
|
|
|||
| # | |||
There was a problem hiding this comment.
Interestingly enough, this is why we have https://github.com/voxpupuli/puppet-lint-param-docs. However, it's disabled here and somehow doesn't catch it. That's a bug.
There was a problem hiding this comment.
Amazing @ekohl thanks for this find!
There was a problem hiding this comment.
It's the most common mistake I've seen with puppet-strings. When things disappear, look for empty lines.
pmcmaw
approved these changes
Aug 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In 37e5bea an empty line was added, splitting the documentation block. Removing the empty line creates a single documentation block again.
Fixes: 37e5bea