docs: fix stale collect.rs module summary for in-shim extraction - #48
Open
cargo-affected-bot wants to merge 2 commits into
Open
docs: fix stale collect.rs module summary for in-shim extraction#48cargo-affected-bot wants to merge 2 commits into
cargo-affected-bot wants to merge 2 commits into
Conversation
#46 moved coverage extraction into the runner shim (spawn-and-wait + in-process extract, per-test result files read back by collect) and updated the module's Approach section, but left the top-of-file summary describing the old execvp + post-run walk/merge/export model. Rewrite the summary to match the Approach section and src/shim.rs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…oc-in-shim-extraction # Conflicts: # src/collect.rs
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
Correct the
collect.rsmodule-level doc comment, which still described the pre-#46 coverage model.Why
#46 moved coverage extraction out of
collectand into the runner shim: each test's shim now spawns and waits for the test binary (no longerexecs), extracts that test's coverage in-process, and writes a per-test result file;collectjust reads those files after nextest exits. The commit updated the detailed "Approach" section of the module doc (and the per-item doc comments) to match, but missed the summary paragraph at the top of the file, which still read:That directly contradicts the "Approach" section a few lines below it (and the actual code in
src/shim.rs, which spawns-and-waits and extracts per-test). This updates the summary to describe the in-shim extraction so the two halves of the doc agree.Testing
Docs-only change — no regression test is feasible (it's a comment).
cargo buildandcargo clippy --all-targetspass locally.