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

@@ -153,7 +153,8 @@ fn resolve_bind_mount_source(target: &Path) -> Result<Option<PathBuf>> {
}
// Found our mount point
let root = parts[3]; // The root within the filesystem
// The root within the filesystem
let root = parts[3];
let fstype_idx = parts.iter().position(|&p| p == "-").map(|i| i + 1);
if let Some(fstype_idx) = fstype_idx {
@@ -664,7 +665,7 @@ mod tests {
);
}
// ─── Unit tests for resolve_via_subvol_mount ─────────────────────────
// Unit tests for resolve_via_subvol_mount
#[test]
fn test_resolve_via_subvol_mount_exact_match() {
@@ -234,9 +234,11 @@ pub fn create_snapshot_with_symlink(btrfs_info: &BtrfsInfo, dest: &Path) -> Resu
/// the identical layout.
pub fn snapshot_dest_path(btrfs_mount: &Path, subvolume_root: &Path, dest: &Path) -> PathBuf {
let subdir = if btrfs_mount == subvolume_root {
BTRFS_SNAPSHOT_SUBDIRS[1] // ".kigi-snapshots"
// ".kigi-snapshots"
BTRFS_SNAPSHOT_SUBDIRS[1]
} else {
BTRFS_SNAPSHOT_SUBDIRS[0] // "worktrees"
// "worktrees"
BTRFS_SNAPSHOT_SUBDIRS[0]
};
let basename = dest
.file_name()