docs(common,tests): discipline comments per comment spec - #24
Open
Boreas618 wants to merge 1 commit into
Open
Conversation
- removed 12 divider banners (§5.4): 7 top-level section banners and 5 in-test step banners in tests/tests.rs - removed 7 narrations of the obvious (§5.1): 2 early-exit comments and 1 target-resolution comment in src/main.rs, 4 "Step N" comments in test_ir in tests/tests.rs - removed 2 floating section-header lines (§9.3) in tests/tests.rs - rewrote 3 comments for form: optimizer-scope narration to the borrow-lifetime constraint in src/main.rs, from_nodes step narration to the forward-branch-target invariant in src/common/graph.rs, and the dead_code rationale in tests/tests.rs stripped of future framing (§3.1) - fixed 3 imprecise docs (§4.1/§8.1) in src/main.rs: module doc says the pipeline (not the output stage) stops early; EmitTarget and the --emit field no longer call a stage an "intermediate representation" - trimmed 1 annotation block duplicating the asmt_tests doc (§2.2) in tests/tests.rs; kept the per-feature cargo invocations
Boreas618
force-pushed
the
docs/comment-discipline-common
branch
from
August 1, 2026 11:00
2ca21f6 to
29097fd
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.
Comment-discipline sweep of
main.rs,common/bitset.rs,common/graph.rs,experimental.rs, andtests/tests.rs, per the repo comment specification:tests/tests.rs(§5.4 — the spec supersedes the recent "divider comments" style commit), plus stage-narrations and floating section headers (§5.1/§9.3).main.rs: removed early-exit narrations; kept the borrow-scope WHY; precision fixes in the module/CLI docs (anasmstage is not an "intermediate representation").common/graph.rs:Graph::from_nodesdoc now states the invariant its construction order exists for (forward label references), not the step narration.bitset.rs/experimental.rsverified compliant, no edits.Comments-only;
cargo buildclean; no new rustdoc warnings.