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:
@@ -20,8 +20,7 @@ pub struct EnvGuard {
|
||||
}
|
||||
|
||||
impl EnvGuard {
|
||||
/// Set `key` to `value` for the guard's lifetime. Accepts `&str`, `&Path`,
|
||||
/// `String`, etc. via `AsRef<OsStr>`.
|
||||
/// Set `key` to `value` for the guard's lifetime.
|
||||
pub fn set(key: &'static str, value: impl AsRef<OsStr>) -> Self {
|
||||
let prior = std::env::var_os(key);
|
||||
// SAFETY: callers are `#[serial]`, so no other thread touches the env.
|
||||
@@ -29,7 +28,6 @@ impl EnvGuard {
|
||||
Self { key, prior }
|
||||
}
|
||||
|
||||
/// Unset `key` for the guard's lifetime.
|
||||
pub fn unset(key: &'static str) -> Self {
|
||||
let prior = std::env::var_os(key);
|
||||
// SAFETY: see [`EnvGuard::set`].
|
||||
@@ -95,7 +93,8 @@ fn ensure_local_kigi_binary(binary: &Path) {
|
||||
);
|
||||
}
|
||||
|
||||
/// Resolve kigi binary: `KIGI_BINARY` env (CI) or a locally built `kigi-tui` binary.
|
||||
/// Resolve the kigi binary, building `kigi-tui` on demand if neither
|
||||
/// `KIGI_BINARY` (CI) nor cargo's own path points at an existing file.
|
||||
pub fn kigi_binary() -> PathBuf {
|
||||
if let Ok(path) = std::env::var("KIGI_BINARY") {
|
||||
let p = PathBuf::from(path);
|
||||
@@ -137,7 +136,7 @@ pub fn git_workdir() -> TempDir {
|
||||
}
|
||||
|
||||
run_git(&["init"], path);
|
||||
// Configure git user for commits (required in CI where no global config exists)
|
||||
// CI has no global git identity, so commits need one configured here.
|
||||
run_git(&["config", "user.email", "test@test.com"], path);
|
||||
run_git(&["config", "user.name", "Test"], path);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user