IncludeResourceDescriptions

The department is: IncludeResourceDescriptions

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

Enabled by default	Supports autocorrection	Target Chef Version
Not Enabled	No	13.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..."

Name	Default value	Configurable values
Version Added	6.1.0	String
Include	`*/resources/.rb`	Array

Was this page helpful?

Still stuck?

How can we improve this document?

Thank you for your feedback!