Skip to content

docs(cli): drop restatement comments in cli tests and helpers#4606

Merged
oferchen merged 1 commit into
masterfrom
docs/comment-cleanup-cli-v2
May 20, 2026
Merged

docs(cli): drop restatement comments in cli tests and helpers#4606
oferchen merged 1 commit into
masterfrom
docs/comment-cleanup-cli-v2

Conversation

@oferchen
Copy link
Copy Markdown
Owner

Summary

Per-crate comment cleanup pass on the cli crate, following the precedent set by PRs #4575 (compress), #4569 (bandwidth), #4584 (filters), #4582 (logging), #4583 (platform), #4587 (matching), #4590 (transfer), #4591 (protocol).

The cli crate is already extensively rustdoc'd (all public items carry docs, #![deny(missing_docs)] is active at the crate root). This pass focuses on the narrow cleanup the precedent PRs target:

  • Removed 11 test-scaffolding line comments that merely echo the next statement (e.g. // Create source file directly above std::fs::write(&source, ...), // Verify the xfr line directly above find(|l| l.contains("xfr#")), // Initially all should be false directly above the corresponding assert!s).
  • Removed one stale 3-line cluster in filter_behavior_comprehensive.rs whose final line ("Actually for simplicity, just verify the directory is excluded") openly contradicted the preceding two lines.
  • Added a leading summary sentence to the rustdoc on frontend::run so the description no longer starts mid-thought ("The function returns ...").

Scope cap

The crate is large (~60 KLoC across 298 files). All // upstream: ... citations, all WHY-annotations (Clap quirks, upstream position invariants, INC_RECURSE semantics, test-section markers, scenario explanations), and all SAFETY-style notes were preserved unchanged. No public-API or test-behaviour changes.

Test plan

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets --all-features --no-deps -- -D warnings
  • CI matrix (fmt+clippy, nextest, Windows, macOS, Linux musl)

Remove test-scaffolding comments that merely echo the line below them, and
add a leading summary sentence to `frontend::run` so its rustdoc no longer
starts mid-thought. No public/test behaviour change.
@oferchen oferchen merged commit ed28ba9 into master May 20, 2026
15 checks passed
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 20, 2026
@oferchen oferchen deleted the docs/comment-cleanup-cli-v2 branch May 21, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant