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

+11 -7
View File
@@ -43,7 +43,7 @@ const CWD_GIT_CACHE_CAP: usize = 64;
/// Called from [`crate::app::acp_handler::handle_git_head_changed`], which
/// also updates the agent's own `current_branch` / `is_worktree` /
/// `main_repo` fields directly. The worktree label isn't carried by the
/// notification (and is immutable for a path), so any previously-resolved
/// notification (and is immutable for a path), so any already-resolved
/// label is preserved. `is_worktree` is derived from `main_repo`, matching
/// how [`compute_cwd_git_info`] populates the cache.
pub fn update_from_notification(dir: &Path, branch: Option<&str>, main_repo: Option<String>) {
@@ -170,7 +170,7 @@ fn spawn_cwd_git_refresh(cwd: PathBuf) {
///
/// A successful probe (`Some`) replaces the entry. A `None` means either
/// "not a git repo" OR a transient libgit2 discovery failure — the two are
/// indistinguishable here — so we preserve any previously-resolved value
/// indistinguishable here — so we preserve any already-resolved value
/// rather than clobbering it with an empty (honoring
/// [`compute_cwd_git_info`]'s contract). A fresh `cwd` with no prior entry
/// still records the `None`, which is correct for a genuine non-repo. The
@@ -330,9 +330,11 @@ fn decide_branch_icon(nerd_fonts: Option<&str>, host: HostOs, brand: TerminalNam
const POWERLINE: &str = "\u{e0a0}";
// Windows console fonts lack `⎇`, so use `≡` (also in the legacy CP437 font).
let fallback = if host == HostOs::Windows {
"\u{2261}" // ≡
// ≡
"\u{2261}"
} else {
"\u{2387}" // ⎇
// ⎇
"\u{2387}"
};
if decide_nerd_fonts(nerd_fonts, host, brand) {
@@ -412,7 +414,7 @@ mod tests {
assert_eq!(cache.len(), CWD_GIT_CACHE_CAP);
}
/// A `None` refresh result must preserve a previously-resolved value (a
/// A `None` refresh result must preserve an already-resolved value (a
/// transient libgit2 discovery failure must not blank the branch), while
/// a fresh cwd with no prior entry still records the `None` (genuine
/// non-repo). Either way the timestamp advances.
@@ -447,8 +449,10 @@ mod tests {
}
const POWERLINE: &str = "\u{e0a0}";
const ALT_KEY: &str = "\u{2387}"; // ⎇
const WIN_FALLBACK: &str = "\u{2261}"; // ≡
// ⎇
const ALT_KEY: &str = "\u{2387}";
// ≡
const WIN_FALLBACK: &str = "\u{2261}";
#[test]
fn windows_default_avoids_powerline_and_alt_key() {