All Puppet classes and defines should be documented via comments directly above the start of the code (style guide).
class ntp {}
# Install and configure an NTP server
# You should feel free to expand on this and document any parameters etc
class ntp {}
To disable this check you can add --no-documentation-check
to your
puppet-lint
command line.
$ puppet-lint --no-documentation-check path/to/file.pp
Alternatively, if you’re calling puppet-lint via the Rake task, you should
insert the following line to your Rakefile
.
PuppetLint.configuration.send('disable_documentation')