docs(cli): drop restatement comments in cli tests and helpers#4606
Merged
Conversation
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.
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
clicrate, following the precedent set by PRs #4575 (compress), #4569 (bandwidth), #4584 (filters), #4582 (logging), #4583 (platform), #4587 (matching), #4590 (transfer), #4591 (protocol).The
clicrate 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:// Create source filedirectly abovestd::fs::write(&source, ...),// Verify the xfr linedirectly abovefind(|l| l.contains("xfr#")),// Initially all should be falsedirectly above the correspondingassert!s).filter_behavior_comprehensive.rswhose final line ("Actually for simplicity, just verify the directory is excluded") openly contradicted the preceding two lines.frontend::runso 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 -- --checkcargo clippy --workspace --all-targets --all-features --no-deps -- -D warnings