docs: tersen rustdoc in cow-layer#619
Merged
Merged
Conversation
mfw78
force-pushed
the
docs/rustdoc-cow-layer
branch
from
July 25, 2026 06:54
745e496 to
b09c657
Compare
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.
What
Aggressive rustdoc decruft across the L3 CoW layer (
cow-venue,composable-cow): crate and module headers, item docs, and the narrative test-helper doc comments compressed to the house terse style.Why
Part of the codebase-wide rustdoc tersening (umbrella #613). The CoW crates carried multi-paragraph field essays, restated examples, and design/history narrative on top of self-evident signatures.
Testing
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps -p cow-venue -p composable-cow --all-features,cargo test --docfor both crates,cargo fmt --all --check,just check-venue-agnostic, andjust check-cow-orderbook-onlyall pass.Rough rustdoc line count for the area fell from ~665 to ~427 (about 238 lines cut).
AI Assistance
Drafted with AI assistance.
Part of #613.