IncludePropertyDescriptions
The department is: IncludePropertyDescriptions
The full name of the cop is: Chef/Sharing/IncludePropertyDescriptions
| Enabled by default | Supports autocorrection | Target Chef Version |
|---|---|---|
| Not Enabled | No | 13.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
| Name | Default value | Configurable values |
|---|---|---|
| Version Added | 6.1.0 | String |
| Include |
|
Array |
Was this page helpful?