docs: tersen rustdoc in runtime supervisor#622
Merged
Conversation
Compress engine_config.rs, supervisor.rs, and supervisor/tests.rs doc comments to the terse house style: one-line item docs, config fields cut to their contract (units, defaults, saturation), restart and poison invariants kept but compressed, and the config-schema, history, and rationale essays dropped. Part of #613.
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 supervisor area:
engine_config.rs,supervisor.rs, andsupervisor/tests.rs.Item docs drop to one line, config fields keep only their contract (units, defaults, saturation behaviour), restart/poison/shutdown invariants are preserved but compressed, and the config-schema TOML dumps, history, migration notes, and rationale essays are cut. A stray
dispatch_blockparagraph misattached toreinstantiate_oneis removed.Why
The house style wants rustdoc terse; these were among the most over-narrated files in the crate. Roughly 859 rustdoc lines before, 490 after across the three files.
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.AI Assistance
Drafted with Claude Code under review.
Part of #613.