(MODULES-4225) add strings to ntp module #366
Conversation
| # Main class, includes all other classes. | ||
| # | ||
| # @example Declaring the class | ||
| # include example |
There was a problem hiding this comment.
I think this may have been copy pasted over by mistake?
| # @param interfaces_ignore [Array[String]] Specifies one or more ignore pattern for the NTP listener configuration (for example: all, wildcard, ipv6). Default value: [ ]. | ||
| # @param keys [Array[String]] Distributes keys to keys file. Default value: [ ]. | ||
| # @param keys_controlkey [Optional. Ntp::Key_id] Specifies the key identifier to use with the ntpq utility. Value in the range of 1 to 65,534 inclusive. Default value: ' '. | ||
| # @ param keys_enable [Boolean] Whether to enable key-based authentication. Default value: false. |
There was a problem hiding this comment.
Typo here, because of the space it's not picking up the comment
| # @param tos_ceiling [Optional Integer[1]] Specifies the ceiling tos option. Default value: 15. | ||
| # @param tos_cohort [Variant Boolean, Integer[0,1]] Specifies the cohort tos option. Valid options: 0 or 1. Default value: 0. | ||
| # @param tinker [Boolean] Whether to enable tinker options. Default value: false. | ||
| # @parudlc_stratum [Optional Integer[1,15]]. Specifies the stratum the server should operate at when using the undisciplined local clock as the time source. This value should be set to no less than 10 if ntpd might be accessible outside your immediate, controlled network. Default value: 10.am udlc [Boolean] Specifies whether to configure NTP to use the undisciplined local clock as a time source. Default value: false. |
There was a problem hiding this comment.
Typo here too it looks like
|
So when I ran this through puppet strings everything looked great except that four parameters are not documented:
|
|
Yeah, I probably missed udlc... authprov, I don't know about. I suspect it's a victim of our manual readme process. What does it do? I can add it. |
|
So looks like this originally came from #306, according to the pull request:
|
|
OK, @HAIL9000 , PR is updated! |
|
Since the
So it seems like it might be prudent just to add a comment to each saying the classes function (as described in the README), and that it is API private and so the user should not be creating instances of it. |
|
So the @api tag is not currently supported for classes (it is for functions though). I filed a ticket to include it for classes (PDOC-156), but we could potentially include it in the meantime in addition to the comments I suggested above. That way, when class support is added it will Just Work. The nice thing about the @api tag is that when it does work it adds this clear warning to users on the generated HTML page:
|
|
@HAIL9000 this is updated again |
| @@ -1,4 +1,6 @@ | |||
| # Private Class | |||
There was a problem hiding this comment.
This comment is redundant now I think we can scrap it
| @@ -1,3 +1,5 @@ | |||
| # @api private | |||
| # This class handles the ntp service. Avoid modifying private classes. | |||
| # | |||
There was a problem hiding this comment.
Absurdly small nitpick, I think we should remove this blank comment line so our formatting is consistent across all the classes
Added strings to init.pp
Made a few very minor changes to the README.