Skip to content

Proposal: Permanently disable subjective "Quality of content" rules #1057

@sharwell

Description

@sharwell

Several documentation rules are subjective and aim to establish the quality of documentation content. These rules take CPU time to evaluate and are an overall poor indicator of documentation quality. I believe with the rules in place, developers will be focused on the wrong aspects of documentation during the development process.

  • SA1628: Documentation text must begin with a capital letter
  • SA1630: Documentation text must contain whitespace
  • SA1631: Documentation must meet character percentage
  • SA1632: Documentation text must meet minimum character length
  • SA1650: Element documentation must be spelled correctly

I propose that each of these rules be permanently disabled in StyleCopAnalyzers.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions