Skip to main content

IncludePropertyDescriptions

All Cookstyle Cops


The department is: Chef/Sharing

The full name of the cop is: Chef/Sharing/IncludePropertyDescriptions


Enabled by defaultSupports autocorrectionTarget Chef Version
Not EnabledNo13.9+

Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.

Examples

incorrect

property :foo, String

correct

property :foo, String, description: "Set the important thing to..."

Configurable attributes

NameDefault valueConfigurable values
Version Added6.1.0String
Include
  • **/libraries/*.rb
  • **/resources/*.rb
Array

Was this page helpful?