IncludeResourceExamples
The department is: Chef/Sharing
The full name of the cop is: Chef/Sharing/IncludeResourceExamples
Enabled by default | Supports autocorrection | Target Chef Version |
---|---|---|
Not Enabled | No | 13.9+ |
Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
Examples
#### correct
```ruby
examples <<~DOC
**Specify a global domain value**
```ruby
macos_userdefaults 'full keyboard access to all controls' do
key 'AppleKeyboardUIMode'
value '2'
end
DOC
Configurable attributes
Name | Default value | Configurable values |
---|---|---|
Version Added | 6.10.0 | String | Include |
| Array |
Was this page helpful?