Update zone documentation #174
Conversation
There was a problem hiding this comment.
Sadly the lint check that would catch this is disabled:
Line 4 in 820cb71
If we would have all parameters documented, it could actually catch this exact problem.
manifests/zone.pp
Outdated
| # @param target_views Array[String] | ||
| # @param zonetype String | ||
| # @param soa String | ||
| # @param reverse Boolean | ||
| # @param ttl String | ||
| # @param refresh Integer | ||
| # @param update_retry Integer | ||
| # @param expire Integer | ||
| # @param negttl Integer | ||
| # @param serial Integer | ||
| # @param masters Array | ||
| # @param allow_transfer Array | ||
| # @param allow_query Array | ||
| # @param also_notify Array | ||
| # @param zone String | ||
| # @param contact Optional[String] | ||
| # @param zonefilepath Stdlib::Absolutepath | ||
| # @param filename String | ||
| # @param forward Enum['first', 'only'] | ||
| # @param forwarders Array | ||
| # @param dns_notify Optional[Enum['yes', 'no', 'explicit']] | ||
| # @param key_directory Optional[Stdlib::Absolutepath] | ||
| # @param inline_signing Optional[Enum['yes', 'no']] | ||
| # @param dnssec_secure_to_insecure Optional[Enum['yes', 'no']] | ||
| # @param auto_dnssec Optional[Enum['allow', 'maintain', 'off']] |
There was a problem hiding this comment.
I think append the type this way doesn't really work. puppet-strings infers the type if there is one. That means you can leave it off. Ideally we would actually have documentation what they do.
There was a problem hiding this comment.
You are right, the type doesn't need to be there.
I haven't added what the params do because I don't really know. My intention was only to fix the mistake with update_policy_rules. Adding the params is only an extra here. You can look at it as a "baby step" :-)
marcdeop
force-pushed
the
fixZoneDocumentation
branch
from
ba50eca
to
100b2f1
Compare
update_policy_ruleswas removed some time ago but I still found a reference to its usage in the zone.pp puppet-strings documentation.This PR updates the docs parameter as well as adding all the other missing ones (even though it doesn't define them, it's better than nothing ;-) ).
Thanks to Erasys GmbH for their support