docs: strip the span rustdoc to bare invariants - #93
Merged
Conversation
mfw78
force-pushed
the
refactor/t8-module-id
branch
from
August 6, 2026 01:33
5d17075 to
b684fce
Compare
AI Assistance: Claude Fable used for the doc pass.
mfw78
force-pushed
the
docs/rustdoc-brutality
branch
from
August 6, 2026 01:41
9201a34 to
08ebbda
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
A final brutality pass over every rustdoc and comment line added in the f97451c...refactor/t8-module-id span: narrative restatements, signature echoes, project-management vocabulary, and phase-by-phase test commentary are gone, leaving only non-obvious invariants, contracts, and fixture constraints; of the 943 comment lines the span added, 608 were deleted or rewritten down to 250 (a net cut of 358 lines), leaving 585 comment lines across 30 files.
Why
Closes #92.
Testing
Light gate only, as agreed for doc passes:
cargo fmt --all -- --check,cargo check -p nexum-runtime --all-features, andRUSTDOCFLAGS='-D warnings' cargo doc --no-deps -p nexum-runtime --all-featuresall pass; the working diff was verified to touch only comment, doc, and blank lines, and the full test battery was not run.AI Assistance
Claude Fable performed the doc pass under maintainer direction.
Note: this PR merges last, after the t5-t8 cars.