docs: note newly-ignored failure mode in new_test.rs module doc - #65
Open
cargo-affected-bot wants to merge 2 commits into
Open
docs: note newly-ignored failure mode in new_test.rs module doc#65cargo-affected-bot wants to merge 2 commits into
cargo-affected-bot wants to merge 2 commits into
Conversation
The module doc says "Two failure modes are guarded here" and enumerates only the perpetually-ignored case and the feature-gating case. The file also guards newly_ignored_test_excluded_from_affected — a distinct mode where a test ignored after collection keeps its coverage rows and must be dropped from the `affected` selection (a different path than new-test detection). Broaden the wording to "Several" and describe that mode so the header matches the tests. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…doc-failure-modes # Conflicts: # tests/functional/new_test.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.
The module doc in
tests/functional/new_test.rsopens with "Two failure modes are guarded here" and then enumerates exactly two: a perpetually-#[ignore]d test not reading asnewforever, and the listing being built with the run's cargo features. But the file also containsnewly_ignored_test_excluded_from_affected, which guards a third, distinct failure mode: a test that becomes#[ignore]d after collection keeps its coverage rows, so a later diff overlapping those rows would pull it intoaffected— and that goes through a different code path (theaffectedselection loop) than thenew-detection split the header describes.Both the doc header and that test were introduced in the same commit (
d5c7dd0), so the "two" was imprecise from the start. This broadens the wording to "Several" and adds a sentence for the newly-ignored mode, so the header matches the tests below it.Phrased count-agnostically on purpose: open PR #41 adds a fifth test (a positional-filter mode) to this same file without touching the header, so "Several" stays accurate whichever of the two lands first. The change is comment-only — no behavioral test applies. Surfaced by the nightly rolling survey.