Reformat Markdown documents - #352
Merged
Merged
Conversation
Apply the repository Markdown formatter to existing documentation so the checked-in files match the current house style. Keep the change scoped to formatter output and leave document content unchanged.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Remove formatter-inserted spacing between sentence punctuation and inline GFM footnote references in the Rust documentation guides. Keep footnote definition lines untouched so reference lists retain their Markdown structure.
leynos
marked this pull request as ready for review
June 8, 2026 20:06
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.
Summary
This branch reformats existing Markdown documents with the repository formatter so the checked-in documentation matches the current house style. It also attaches inline GFM footnote references that had been split away from preceding punctuation during reflow, while leaving
[^n]:footnote definition lines untouched.Review walkthrough
Validation
make fmt: passed.[^n]:definitions: passed with no matches.make markdownlint: passed with 0 errors.make nixie: passed; all diagrams validated successfully.make check-fmt: passed.git diff --check: passed.Notes
The Markdown audit checked for corrupted fences, links, lists, footnotes, tables,
and diagram blocks. The observed broad reformat changes are formatter reflow,
indentation normalisation, and table alignment. The follow-up sweep found and
fixed three inline references where spacing separated the reference from the
preceding punctuation.