Repository navigation
Reflow every doc comment to 80 columns - #53
Merged
Merged
Conversation
Rewrap the doc comments of every crate, the detached fuzz workspace
included, so that their paragraphs fill the whole source line up to 80
columns. The rewrap is `cargo doc-fmt`, from the unpublished
`rustdoc-fmt` crate in cargo-doc-edit, run as:
cargo doc-fmt --all -- --config comment_width=80
cargo doc-fmt --all --manifest-path crates/before/fuzz/Cargo.toml \
-- --config comment_width=80
The change is whitespace inside doc comments. No code changed: with
every comment removed, each file is byte-identical to its parent. No
word changed, except that the rewrap aligns markdown tables, padding
cells and sizing delimiter rows to the column widths, so a few table
rows grow past 80 columns. Rustdoc renders every page of `rumors`,
`before`, `suanpan` and `rumors-tracing` the same apart from
whitespace, in the public and private builds. The search index's
truncated summaries move their cut by a word in a few places: rustdoc
admits a summary's last word when a line break follows it and not when
a space does.
The doc lines still over 80 columns are table rows, fenced code, URLs,
single words too wide for their line, and doc comments inside macro
invocations such as `proptest!`, whose bodies the rewrap leaves alone.
`fuzzfit/harness/src/bands.rs` keeps its layout because
`bin/calibrate` writes it.
The READMEs mirror the crate docs, so `just readme` regenerates them.
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.
Mechanically rewrap absolutely every doc comment in the workspace to make them nicely fit in 80 columns.