docs: tersen rustdoc in sdk-periphery-l1#624
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
Tersens rustdoc across the sdk-periphery-l1 area: the nexum-sdk periphery (chain/, http, config, address, events, tracing, proptests, wit_bindgen_macro), nexum-world, nexum-module-macros, nexum-launch, nexum-tasks, nexum-cli, shepherd, and no-std-probe. Item docs compress to one factual line where one suffices; restated signatures, examples that mirror the code, rationale, and note-that narrative are cut, while invariants and contract statements are kept in compressed form. Comment-only changes; no code, wit/, or markdown touched. Rustdoc lines in the touched files go from roughly 700 to roughly 410.
Why
House style is terse rustdoc; the area carried design narrative and restated detail that the code already says. Part of #613.
Testing
RUSTDOCFLAGS="-D warnings" cargo doc --no-depsover all eight area crates,cargo fmt --all --check,just check-venue-agnostic, andjust check-cow-orderbook-onlyall pass undernix develop.AI Assistance
Drafted with AI assistance and reviewed by the author.