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
@@ -3,8 +3,7 @@
//! Two pieces stay here:
//! - The [`instrumentation_timer!`] macro, because it's `#[macro_export]`-ed
//! from this crate and call sites spell it `crate::instrumentation_timer!`
//! (i.e. `kigi_shell::instrumentation_timer!`). Keeping the macro here
//! means downstream callers don't need to be edited.
//! (i.e. `kigi_shell::instrumentation_timer!`).
//! - [`finalize_and_exit`], because shell needs to log a terminal exit event
//! and flush instrumentation before the process exits.
@@ -17,8 +16,6 @@ pub use kigi_log::instrumentation::{
/// Final cleanup before terminating the process.
///
/// Logs an exit event, flushes instrumentation guards, and exits with `code`.
///
/// Stays in shell so callers can keep calling `kigi_shell::instrumentation::finalize_and_exit`.
pub fn finalize_and_exit(code: i32) -> ! {
let signal_name = match code {
130 => "SIGINT",
@@ -42,8 +39,6 @@ pub fn finalize_and_exit(code: i32) -> ! {
/// Macro stays in shell so `$crate` continues to resolve to `kigi_shell`
/// for the 12+ existing call sites that spell it as
/// `crate::instrumentation_timer!(...)` or `kigi_shell::instrumentation_timer!(...)`.
/// The macro body delegates to types and functions in
/// `kigi_log::instrumentation`.
#[macro_export]
macro_rules! instrumentation_timer {
($name:literal) => {{