Skip to content

Don't set empty property descriptions #905

Description

@tas50

What category of cop is this?:

Please try to select as few as possible.

  • Chef/Deprecations - A cop that alerts on a deprecation in the Chef Infra Client
  • Chef/Correctness - A cop that alerts when incorrect coding behavior is being used
  • Chef/Sharing - A cop that alerts to missing functionality necessary for sharing cookbooks with others
  • Chef/Style - A cop that alerts to a style best practice
  • Chef/Modernize - A cop that alerts when a cookbook can be simplified or modernized with new functionality
  • Chef/Effortless - A cop that alerts on code that must be resolved to move to the Effortless pattern
  • Chef/RedundantCode - A cop that detects redundant code regardless of Chef Infra release
  • InSpec/Deprecations - A cop that alerts on a deprecation in the Chef InSpec

Describe the new cop:

There's no point in setting an empty string as a desription.

What it would trigger on:

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

What it would autocorrect to if applicable

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    New Cop ProposalA proposal for a new Cookstyle copStatus: UntriagedAn issue that has yet to be triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions