Add reference docs and remove redundant recurse parameter
#9
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
alexjfisher
force-pushed
the
puppet-strings
branch
from
27102ab
to
2c10a96
Compare
ekohl
approved these changes
Nov 5, 2018
alexjfisher
force-pushed
the
puppet-strings
branch
2 times, most recently
from
3f8b65c
to
884813d
Compare
ekohl
reviewed
Nov 5, 2018
README.md
Outdated
|
|
||
| ## Reference | ||
|
|
||
| This module has been documented with [puppet-strings](https://github.com/puppetlabs/puppet-strings). See [REFERENCE.md](REFERENCE.md). |
There was a problem hiding this comment.
I'd first link to the reference and then tell you how it's generated.
There was a problem hiding this comment.
Fixed. I've also added the command to generate it to the Development section.
REFERENCE.md
Outdated
|
|
||
| Data type: `Optional[Stdlib::Filemode]` | ||
|
|
||
| The mode to use for the command file. Defaults to `$nrpe::command_file_default_mode`. |
There was a problem hiding this comment.
Below it says it defaults to undef. Perhaps it should say it'll use that var when it's undef?
alexjfisher
force-pushed
the
puppet-strings
branch
from
884813d
to
0bf8479
Compare
alexjfisher
changed the title
recurse parameterrecurse parameter
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.
recurseparameter has been removed. The relevant file resource now uses just the value ofnrpe::purgefor bothpurgeandrecurse.purgeis now justBoolean, instead ofOptional[Boolean]Documentation came from the template file comments, this PR, (thanks @vollmerk), and stuff I made up myself.