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:
2026-07-23 16:55:39 -04:00
parent ff0fb56c67
commit a02b555e66
1458 changed files with 10729 additions and 21750 deletions
@@ -34,7 +34,8 @@ const SIGINT_CANARY: &str = "SIGINTCANARY7";
const ACK: &str = "ACKSENTINEL";
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
#[ignore] // opt-in: spawns the real pager binary in a PTY (CI runs with --ignored)
// opt-in: spawns the real pager binary in a PTY (CI runs with --ignored)
#[ignore]
async fn prompt_history_durable_after_double_ctrl_c_and_recallable_on_resume() {
run().await.expect("prompt-history durable-quit e2e");
}
@@ -43,7 +44,8 @@ async fn prompt_history_durable_after_double_ctrl_c_and_recallable_on_resume() {
/// same graceful quit: the prompt stays durable and the process exits 0.
#[cfg(unix)]
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
#[ignore] // opt-in: spawns the real pager binary in a PTY (CI runs with --ignored)
// opt-in: spawns the real pager binary in a PTY (CI runs with --ignored)
#[ignore]
async fn prompt_history_durable_after_real_sigint_graceful_quit() {
run_sigint().await.expect("sigint graceful-quit e2e");
}
@@ -197,7 +199,8 @@ fn submit_and_settle(
pager
.wait_for_text(ACK, Duration::from_secs(30))
.context("turn response rendered")?;
pager.update(Duration::from_millis(1000)); // let the short turn finish (idle)
// let the short turn finish (idle)
pager.update(Duration::from_millis(1000));
Ok(pager)
}