docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment guidelines: delete redundant restatements, decorative banners, change narration, and end-of-line comments; keep and tighten the crucial ones (invariants, bug rationale, SAFETY blocks, ported-source attribution). No functional code changed. Every edit is proven comment-only against the prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a separate doctest-fence check. Where removing a comment made rustfmt or clippy want to re-lay-out adjacent code, the minimal triggering comment is restored so code tokens stay byte-identical. Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy --workspace --all-targets (0 warnings). Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for these guidelines (flags banners, end-of-line comments, change narration, and commented-out code).
This commit is contained in:
@@ -45,8 +45,6 @@ fn all_user_message_blobs(content: &ContentController) -> Vec<String> {
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Mid-turn queue via Enter, then empty Enter cancels the running turn and
|
||||
/// runs that row as the next turn (cancel-and-send).
|
||||
pub async fn assert_empty_enter_force_sends_top_queued() -> Result<()> {
|
||||
let content = ContentController::start()
|
||||
.await
|
||||
@@ -79,13 +77,11 @@ pub async fn assert_empty_enter_force_sends_top_queued() -> Result<()> {
|
||||
.context("queued text visible")?;
|
||||
|
||||
harness.inject_keys(b"\r").context("empty Enter send-now")?;
|
||||
// Cancel-and-send: the shell cancels turn 1 (its held completion is
|
||||
// irrelevant — the abort wins) and promotes the row to run as turn 2.
|
||||
// Release the gate so any completion race resolves rather than hangs.
|
||||
// Release the gate so a completion racing the abort resolves rather than
|
||||
// hangs.
|
||||
content.release_agent_completions();
|
||||
// The promoted row renders as a standard user prompt block ("❯ " prefix
|
||||
// distinguishes the committed block from the prefix-less queue row) with
|
||||
// the new turn's reply below it.
|
||||
// The "❯ " prefix distinguishes the committed prompt block from the
|
||||
// prefix-less queue row.
|
||||
harness
|
||||
.wait_for_text(
|
||||
"\u{276F} please also check the logs",
|
||||
@@ -96,8 +92,6 @@ pub async fn assert_empty_enter_force_sends_top_queued() -> Result<()> {
|
||||
.wait_for_text("TURNTWO", Duration::from_secs(40))
|
||||
.context("promoted turn reply")?;
|
||||
|
||||
// A send-now cancel is silent: no "Turn cancelled by user" marker may
|
||||
// appear between the partial turn-1 output and the promoted prompt.
|
||||
if harness.contains_text("Turn cancelled by user") {
|
||||
bail!(
|
||||
"send-now cancel must not render a cancelled marker\n{}",
|
||||
|
||||
Reference in New Issue
Block a user