docs: Remove arbitrary line breaks in markdown prose - #2220
Merged
Conversation
Prose paragraphs and list items were hard-wrapped at roughly 80-90 characters in thirteen files, against the convention everywhere else in the repo, where a paragraph or list item is one line. MD013 is disabled in .markdownlint-cli2.jsonc, so line length is deliberately unenforced. Hard wrapping makes diffs noisier than the edit: changing a word reflows the rest of the paragraph, so a one-word change shows as several changed lines and review has to re-read them all. Joins each wrapped paragraph and list item onto a single line. Content is byte-identical under whitespace normalization, verified per file before writing. Frontmatter, code fences, tables, blockquotes, HTML and Vue blocks, containers, link reference definitions, and explicit two-space hard breaks are all left untouched; no fence or table line appears in the diff. markdownlint-cli2 reports 0 issues across all 183 files.
Contributor
|
|
FaciōQuōqa Mage Reviewer is standing by.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Coverage variation | ✅ -0.01% coverage variation (-1.00%) |
| Diff coverage | ✅ ∅ diff coverage |
Coverage variation details
Coverable lines Covered lines Coverage Common ancestor commit (884b594) 19640 18952 96.50% Head commit (bf3f9ad) 19680 (+40) 18988 (+36) 96.48% (-0.01%) Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch:
<coverage of head commit> - <coverage of common ancestor commit>
Diff coverage details
Coverable lines Covered lines Diff coverage Pull request (#2220) 0 0 ∅ (not applicable) Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified:
<covered lines added or modified>/<coverable lines added or modified> * 100%
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
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
1 participant
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.
Prose paragraphs and list items were hard-wrapped at roughly 80–90 characters in thirteen files, against the convention everywhere else in the repo, where a paragraph or list item is one line.
MD013is disabled in.markdownlint-cli2.jsonc, so line length is deliberately unenforced.Hard wrapping makes diffs noisier than the edit: changing a word reflows the rest of the paragraph, so a one-word change shows as several changed lines and review has to re-read all of them. Some of this was mine — the shim correction notes added in #2210 and #2214 were wrapped.
Scope
13 files, 54 joined lines. Three account for most of it:
tools/performance/benchmarking.mddocs/migration/v3.mddocs/CONTRIBUTING.mdFinding them took two attempts. A naive scan reported 117 files and 984 lines, but almost all were VitePress YAML frontmatter and Vue
<ClientOnly>blocks rather than prose. Excluding frontmatter, fences, tables, blockquotes, HTML/Vue blocks, containers, and link reference definitions brings it to the real set above.Safety
Content is byte-identical under whitespace normalization, asserted per file before writing — a file whose normalized text changed would have been skipped, and none were.
Left untouched: YAML frontmatter, code fences, tables, blockquotes, HTML and Vue blocks,
:::containers, link reference definitions, and explicit two-space hard breaks (which are a real<br>and must not be joined). No fence or table line appears anywhere in the diff — verified by grepping the diff itself.markdownlint-cli2reports 0 issues across all 183 files, and the detector now finds zero remaining wrapped prose.Merge order
No constraint. Verified clean against both open PRs (#2218, #2219) in every direction — those two carry their own added prose already unwrapped, so nothing here overlaps them.