Skip to main content

IncludeResourceExamples

All Cookstyle Cops


The department is: Chef/Sharing

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


Enabled by defaultSupports autocorrectionTarget Chef Version
Not EnabledNo13.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

NameDefault valueConfigurable values
Version Added6.10.0String
Include
  • **/resources/*.rb
Array

Was this page helpful?