Use puppet-strings for reference docs #58
Conversation
|
The parameters currently missing documentation are...
I decided to leave them out of this PR and will create a separate PR for them. I can also create follow-up PRs to
Let me know what you think. Again, I didn't want to put too much in this single PR (making it hard to review). |
| @@ -111,6 +111,9 @@ class { '::chrony': | |||
| port => 123, | |||
| } | |||
| ``` | |||
| #### Note | |||
There was a problem hiding this comment.
This note had got separated from its example.
| # main chrony class | ||
| # @summary Installs and configures chrony | ||
| # | ||
| # @example Install chrony with default options |
There was a problem hiding this comment.
I've copied the examples from the README, but not deleted them (yet). I think it's nice that there are at least a few of the most important examples there and not just in the reference docs.
manifests/init.pp
Outdated
| # stepping the time may be wanted. In this case, set `makestep_updates` to `-1` | ||
| # to allow stepping the time for any update. | ||
| # @param makestep_updates | ||
| # Together with `makestep_seconds`, this configures the `makestep` parameter of `chronyd`. |
There was a problem hiding this comment.
I wasn't sure what to do here. Happy to change this to new wording (to remove the duplication), or perhaps this could be done in a future PR.
There was a problem hiding this comment.
Please reword this, it's horrible to get your head around these sentences.
There was a problem hiding this comment.
Reworded and linked to official docs (which aren't great either TBH). I've also added an @example and data types to the parameters.
|
@alexjfisher nice work, |
Not all parameters are currently documented. This commit migrates the ones that were documented in the README to REFERENCE.md using puppet strings.
alexjfisher
force-pushed
the
puppet-strings
branch
from
1f13111 to
bc6af32
Compare
|
@alexjfisher is it ready for merging? |
yes. I was going to leave further improvements to future PRs. I didn't want to mix too many things in one diff making it hard to review. |
Not all parameters are currently documented. This commit migrates the
ones that were documented in the README to REFERENCE.md using puppet
strings.