Chef/Sharing/IncludeResourceDescriptions
The Cookstyle cops department: Chef/Sharing
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 |