Skip to main content

IncludeResourceDescriptions

All Cookstyle Cops


The department is: Chef/Sharing

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


Enabled by defaultSupports autocorrectionTarget Chef Version
Not EnabledNo13.9+

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

Examples


#### correct

```ruby
resource_name :foo
description "The foo resource is used to do..."

Configurable attributes

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

Was this page helpful?