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:
ZacharyZhang-NY committed 2026-07-23 16:55:39 -04:00
1 parent ff0fb56c67
commit a02b555e66
1458 files changed
+10729 -21750

No files matched your search

@@ -64,7 +64,6 @@ impl SlashCommand for TerminalSetupCommand {
let mut out = String::new();
// -- Environment --
out.push_str("Environment\n");
out.push_str(&format!(" terminal {}\n", ctx.brand));
if let Some(v) = crate::terminal::xtversion::detected() {
@@ -122,7 +121,6 @@ impl SlashCommand for TerminalSetupCommand {
out.push_str(&format!(" newline Alt+Enter ({detail})\n"));
}
// -- Clipboard --
out.push_str("\nClipboard routes\n");
out.push_str(&format!(
" native {} (tool: {})\n",
@@ -142,7 +140,6 @@ impl SlashCommand for TerminalSetupCommand {
crate::clipboard::wayland_data_control_label()
));
// -- Diagnostics --
if warnings.is_empty() {
out.push_str("\nNo issues found.\n");
} else {