(maint) Fix puppet-strings docs on apache::vhost #2165
Merged
Conversation
This file contains hidden or 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
This was referenced Jul 13, 2021
Collaborator
Author
|
For what it's worth: https://github.com/voxpupuli/puppet-lint-param-docs would have caught this. |
With this empty line between the commend and the define, puppet-strings doesn't consider the comment as a documentation string. That means all the documentation that is written doesn't show up in REFERENCE.md. Fixes: 7e233fe
ekohl
force-pushed
the
fix-reference-docs
branch
from
53682b3 to
bbfdc93
Compare
Collaborator
Author
|
I now regenerated REFERENCE.md. |
Collaborator
Author
|
@sheenaajay could you take a look? |
bastelfreak
approved these changes
Jul 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
With this empty line between the commend and the define, puppet-strings doesn't consider the comment as a documentation string. That means all the documentation that is written doesn't show up in REFERENCE.md.
I can't regenerate REFERENCE.md due to a missing puppet-module-posix-default-r3.0 gem so somebody else has to do that.
It was found in https://github.com/puppetlabs/puppetlabs-apache/pull/2157/files#r663838497 and introduced in 7e233fe.