Chef/Sharing/EmptyPropertyDescription

The Cookstyle cops department: Chef/Sharing

Enabled by default	Supports autocorrection	Target Chef Version
Enabled	No	All Versions

Resource properties should not set an empty description. Automated documentation tools have nothing to render from it, so it does no more than a missing field would while looking like the property has been documented.

Examples

# bad
property :site_name, String,
         name_property: true,
         description: ''

# good
property :site_name, String,
         name_property: true,
         description: 'The name of the site'

Configurable attributes

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