docs(core): drop restatement comments in tests across core#4598
Merged
Conversation
Removes test-section header banners ("Tests for X"), comments that
restate the next line or assertion message, and a handful of phrasing
duplicates in tests. Preserves every upstream cite, WHY note explaining
non-obvious invariants (iconv apply hook ordering, INC_RECURSE gating,
local-copy progress assumptions, sparse fallback semantics), and the
existing safety attributions. No semantic changes.
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
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.
Summary
Per-crate comment cleanup pass on the
corecrate, following the same precedent as PRs #4591 (protocol), #4590 (transfer), #4589 (fast_io), #4584 (filters), #4582 (logging), #4583 (platform), #4587 (matching), #4575 (compress).The
corecrate was already in good shape thanks to its#![deny(missing_docs)]policy:main.c,options.c,compat.c,flist.c,rsync.c,clientserver.c,util1.c,log.c) and WHY notes covering iconv apply hook ordering, INC_RECURSE gating, local-copy progress assumptions, transport-selection rationale, and shell quoting rules - all preserved.signal/subtree was excluded from this pass per the BR-10b precedent (PR fix(core): move sigaction unsafe out of core into fast_io #4571); its docs are already accurate.Net change: 69 lines removed, 1 added across 12 files. Removals target:
// Tests for X) that simply prefix a group of#[test]functions whose names already describe the subject.Scope coverage
Walked the entire
crates/core/src/tree exceptsignal/(excluded per task scope). No scope cap applied - the crate was already clean enough that the full walk fit comfortably within one PR.Test plan
cargo fmt --all -- --checkcargo clippy --workspace --all-targets --all-features --no-deps -- -D warnings