docs: sweep CHANGELOG for the documentation style check - #366
Merged
Conversation
CHANGELOG carried 172 style findings, so the next PR to touch it would have inherited the cleanup mid-release. Clearing it now keeps that off the release path. Removes 176 em dashes, resolved by what each clause was doing rather than by one substitution: paired asides became parentheses, bold lead-ins took a colon, appositives a comma, and independent clauses a semicolon or a sentence break. A first pass produced eleven comma splices where an em dash had ended a line introducing an explanation; those are colons now. Migrates all 23 version headings to the parenthesised date form CONTRIBUTING adopted in #365. docs_check validates that a heading carries an ISO date, not which separator precedes it, so both forms pass and no gate changed. Renames "behavior harness" to "check-behavior suite" and cites rule_behavior_harness_test.go in code font. The checker reads "harness" as hype; here it is the shipped artifact's name, so the name stays, in a span the checker exempts. The false positive is filed against the shared tool. Verified content-preserving: after normalising punctuation, the whole file differs by exactly the two intended word changes above. Reference counts are unchanged at 75 PR links, 2 markdown links, and 153 bold spans.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CHANGELOG.mdcarried 172 findings against the Doc style check added in #364.The check scans changed files whole, so the next PR to touch this file would have
inherited the cleanup mid-release. Clearing it now keeps that off the release
path.
Please read the diff rather than merging on green. This rewrites a public
historical record, and no gate can tell you whether the prose still reads well.
What changed
by one substitution: paired asides became parentheses (5), bold lead-ins took a
colon (26), appositives a comma (105), independent clauses a semicolon, and
four became sentence breaks.
## vX.Y.Z (YYYY-MM-DD), matching theformat CONTRIBUTING adopted in docs: align CONTRIBUTING with the shared git and GitHub standard #365.
docs_check.shvalidates that a headingcarries an ISO date, not which separator precedes it, so both forms pass and no
gate changed.
rule_behavior_harness_test.goin code font. The checker readsharnessashype; here it is the shipped artifact's name. Putting the real name in a code
span keeps the record accurate in a context the checker exempts, rather than
suppressing the finding or renaming history. The false positive is filed
against the shared tool.
Why the first pass was not enough
A pattern-aware transform still produced eleven comma splices, all from the
same cause: an em dash ending a line almost always introduces an explanation, so
a comma reads as a run-on. Examples now fixed:
This is the honest result, those rules do not applybecomes a colon.The old path had no equivalent, it relied on the schedulerbecomes a colon.pwquality difok. CIS >= 2had a period inserted inside a parenthetical.Verification that content survived
After normalising punctuation, the entire file differs from its previous state by
exactly the two intended word changes above. Nothing else moved.
make docs-checkandmake docs-styleboth pass.