IncludeResourceDescriptions
The department is: Chef/Sharing
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..."
Configurable attributes
| Name | Default value | Configurable values |
|---|---|---|
| Version Added | 6.1.0 | String |
| Include |
|
Array |
© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs.chef.io/workstation/cookstyle/chef_sharing_includeresourcedescriptions/
