Fix documentation about parameter port. #84
Conversation
|
@vchepkov, do you think this is good? |
| @@ -136,10 +135,9 @@ | |||
| # Also see [`makestep_seconds`](#makestep_seconds). | |||
| # @param queryhosts | |||
| # This adds the networks, hosts that are allowed to query the daemon. | |||
| # Note that `port` needs to be set for this to work. | |||
There was a problem hiding this comment.
The reference is generated by calling bundle exec rake strings:generate:reference and it looks like this isn't reflected there.
There was a problem hiding this comment.
I think that the docstring in init.pp is correct now, neither of init.pp or REFERENCE.md
has that note anymore. Probably the reference shoult be regenerated anyway?
manifests/init.pp
Outdated
| # Port the service should listen on, to be used in combination with `queryhosts`. | ||
| # Module default is `0` to prevent accidental activation of server mode. | ||
| # Port the service should listen on. | ||
| # Module default is undef. |
There was a problem hiding this comment.
what does a default of undef mean?
why is it significant that it's a "module default"? as opposed to?
why do you have to spell it out here, rather than that default being pulled out from the code?
There was a problem hiding this comment.
Good questions
Is this better?
# Port the service should listen on. Module default is `undef` which means that port
# isn't added to chrony.conf, and chrony listens to the default ntp port 123 if
# `queryhosts` is used.
This uptdates the documentation to match the current code concerning parameter port.
|
I have force-pushed with the wording-change suggested by @igalic |
This uptdates the documentation to match the current code concerning parameter port.