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:
1 parent
ff0fb56c67
commit
a02b555e66
1458 files changed
+10729
-21750
No files matched your search
@@ -26,14 +26,12 @@ pub fn set_version(ver: &str) {
|
||||
|
||||
pub const LOG_DIR: &str = "logs";
|
||||
const LOG_FILE: &str = "unified.jsonl";
|
||||
pub const MAX_SIZE: u64 = 5 * 1024 * 1024; // 5 MB
|
||||
pub const MAX_SIZE: u64 = 5 * 1024 * 1024;
|
||||
|
||||
/// ACP method name for unified log notifications.
|
||||
pub const LOG_METHOD: &str = "kigi/log";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Log entry types
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Log level for a unified log entry.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, strum::Display, Serialize, Deserialize)]
|
||||
@@ -126,9 +124,7 @@ pub struct ClientLogEntry {
|
||||
pub ctx: Option<serde_json::Value>,
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Writer
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
struct LogWriter {
|
||||
file: File,
|
||||
@@ -228,9 +224,7 @@ pub fn trim_file(path: &std::path::Path) {
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Public API
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Return a new timestamp string in the unified log format.
|
||||
fn now_ts() -> String {
|
||||
@@ -315,7 +309,7 @@ pub fn snapshot_log() -> Option<Vec<u8>> {
|
||||
{
|
||||
let _ = w.file.flush();
|
||||
}
|
||||
// Lock released intentionally — snapshot is approximate.
|
||||
// Lock released deliberately — snapshot is approximate.
|
||||
match fs::read(&path) {
|
||||
Ok(data) if !data.is_empty() => Some(data),
|
||||
_ => None,
|
||||
|
||||
Reference in new issue
Block a user