Skip to main content

Chef/Sharing/IncludeResourceDescriptions

Cookstyle cops page

The Cookstyle cops department: Chef/Sharing

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

Thank you for your feedback!

×









Search Results