chore: strip redundant comments and PR-number test prefixes#25
Merged
Itsusinn merged 2 commits intoJun 14, 2026
Merged
Conversation
chore: strip redundant comments and PR-number test prefixes Remove restate-the-obvious comments across all own crates and drop the PR-number tokens baked into test function names. Comments: delete section-divider banners, label comments, and comments that merely echo the adjacent code (and the stray trailing comments that duplicate the line). All "why"/rationale, invariants, SAFETY notes, protocol/RFC references, config-field docs, and module/API docs are kept. ~782 comment lines removed; no logic changes. Test names: strip the prN_/test_prN_ prefixes that encoded PR numbers (e.g. pr4_acl_ipv6_address_yields_128_host_route -> acl_ipv6_address_yields_128_host_route), keeping the descriptive remainder. 22 functions renamed; all are in-module tests with no external callers. cargo check --workspace --all-targets passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @
style: rustfmt collapse call after trailing-comment removal Removing the trailing comment let rustfmt fold the multi-line test_socks5_udp_large_packet call onto one line. Fixes `cargo +nightly fmt --all -- --check` on the Build / prepare CI step. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @
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.
@
What
Two non-functional cleanups across all own crates (
crates/, vendoredpatches/untouched):// ===== Foo =====,// ── bar ──), label comments naming obvious blocks, and comments that merely restate the adjacent code (plus stray trailing comments echoing their line).pr4_acl_ipv6_address_yields_128_host_route→acl_ipv6_address_yields_128_host_route,pr5_format_protocol_zero_alloc_output→format_protocol_zero_alloc_output,test_pr2_fragmented_udp_emits_no_info_log_noise→test_fragmented_udp_emits_no_info_log_noise. The descriptive remainder is kept.Why
The
prN_prefixes encode PR numbers that mean nothing to a future reader, and pair with the now-removed "PRn regression tests" banner comments. The comment pass drops noise that duplicated the code while keeping every comment that earns its place: rationale/"why", invariants,SAFETY:notes, protocol/RFC references, byte-layout annotations, user-facing config-field docs, and all//!////module/API docs.Reviewer notes
fnrenames only.#[test]/#[tokio::test]fns with no external callers; no collisions after stripping.wind-test/src/tuic.rsthat referenced the old span name (test_pr2_..._noise:→test_..._noise:); thetracing-testlogs_assertfilter derives the span from the live fn name, so behavior is unchanged. The descriptive"PR2 demoted log …"error string was intentionally left as prose.cargo check --workspace --all-targetspasses..gitmodules/.github/remote-workflowssubmodule setup in the working tree is unrelated and deliberately not part of this PR.🤖 Generated with Claude Code
@