docs: trimmed rules h1s to just be rule names #15514
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Moves the description of each rule out of its h1 and into a one-line sentence after.
Fixes #15471.
Is there anything you'd like reviewers to focus on?
There were actually quite a few rules that had different text in their docs heading compared to their
meta.docs.description
.Separate from this PR I'd suggest adding testing to make sure they stay in sync. I think a good heuristic to fix them all up would be to take the longer between the docs intro paragraph from this PR and the description from the rule itself.Aha, they're in the makefile! Fixing up now before un-drafting.✅I didn't add a check that the docs page description matches the rule meta docs, because they generally don't. But if you'd like me to make that change in this PR I'd be happy to.
Here's a quick script I used to get these changes mostly done...