docs: tersen rustdoc in runtime host#623
Merged
Merged
Conversation
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
Tersen the rustdoc across the runtime host-side surface (
crates/nexum-runtime/src/host): provider pool, extension seam, log pipeline, redb local store, HTTP gate, component seams, actor, error projections, and the near-cleanimpls/headers.Why
House style: rustdoc stays terse. The host modules carried knob-by-knob and plumbing-narrative doc comments, restated signatures, rationale, and external-project colour (alloy, ENS). This cuts each item to one factual line while preserving real invariants (quota atomicity, HTTP deadline/allowlist semantics, reorg
removedflag, liveness death-instant, messaging topic scope).Testing
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps -p nexum-runtime,cargo test --doc -p nexum-runtime,cargo fmt --all --check,just check-venue-agnostic, andjust check-cow-orderbook-only, all green undernix develop.Rough rustdoc line count for this area: 760 before, 462 after.
AI Assistance
Drafted with Claude Code under review.
Part of #613.