Skip to content

Repo: Enforce that all rules have a "When Not To Use It" docs section? #7257

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Suggestion

Right now, about 70 rule docs files have a ## When Not To Use It heading. Is this practice something we want to standardize for all rules and enforce as a CI/lint/test check?

FWIW I'd be in favor. I think it's good to always portray a nuanced view of when you would or wouldn't want to use a rule.

Metadata

Metadata

Labels

accepting prsGo ahead, send a pull request that resolves this issuerepo maintenancethings to do with maintenance of the repo, and not with code/docs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions