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
+7 -4
View File
@@ -277,7 +277,8 @@ pub fn parse_hook_file(content: &str, file_path: &Path) -> (Vec<HookSpec>, Vec<H
// Step 2: extract only the "hooks" key. If absent, the file has no hooks.
let hooks_value = match top_level.get("hooks") {
Some(v) => v.clone(),
None => return (specs, errors), // No hooks key — not an error, just no hooks.
// No hooks key — not an error, just no hooks.
None => return (specs, errors),
};
let hooks_map: HooksMap = match HooksMap::from_value(hooks_value) {
@@ -517,7 +518,8 @@ mod tests {
assert_eq!(s.event, HookEventName::PreToolUse);
assert!(s.matcher.is_some());
assert!(s.enabled);
assert_eq!(s.timeout_ms, 2000); // 2 seconds → 2000 ms
// 2 seconds → 2000 ms
assert_eq!(s.timeout_ms, 2000);
assert_eq!(s.command, Some(PathBuf::from("bin/check.sh")));
}
@@ -554,7 +556,8 @@ mod tests {
}"#;
let (specs, errors) = parse_hook_file(json, Path::new("/tmp/test.json"));
assert!(errors.is_empty());
assert!(specs[0].matcher.is_none()); // empty string → None → match all
// empty string → None → match all
assert!(specs[0].matcher.is_none());
}
#[test]
@@ -1072,7 +1075,7 @@ mod tests {
);
}
/// `matcher` is intentionally NOT env-expanded. A
/// `matcher` is deliberately NOT env-expanded. A
/// matcher with `$VAR` must store the literal `$VAR` (anchored as
/// part of the regex by `HookMatcher::new`). A future contributor
/// adding "completeness" here would break regex semantics.