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
+17 -80
View File
@@ -6,7 +6,6 @@
#![allow(clippy::derive_partial_eq_without_eq)]
/// Generated protobuf types.
pub mod pb {
include!(concat!(env!("OUT_DIR"), "/kigi.tools.v1.rs"));
}
@@ -14,84 +13,24 @@ pub mod pb {
pub mod config_validation;
pub mod slash_commands;
// Re-export commonly used types at the crate root for convenience
pub use pb::{
// Agent types
AgentCompletionRequirement,
AgentToolExecConfig,
AgentToolRetryConfig,
// Request/response types
ClearToolOverrideRequest,
ClearToolOverrideResponse,
DisableToolRequest,
DisableToolResponse,
EnableToolRequest,
EnableToolResponse,
// Enums
ErrorCode,
ExecuteToolRequest,
ExecuteToolResponse,
ExecutionMetadata,
ExecutionOptions,
FinalizeAgentRequest,
FinalizeAgentResponse,
FinalizeConfigValidationDetails,
FinalizeConfigViolation,
// Tool server config (finalize-time)
FinalizeToolServerConfigRequest,
FinalizeToolServerConfigResponse,
GetAgentInfoRequest,
GetAgentInfoResponse,
GetCompletionStateRequest,
GetCompletionStateResponse,
GetSystemPromptRequest,
GetSystemPromptResponse,
GetSystemRemindersRequest,
GetSystemRemindersResponse,
GetToolInfoRequest,
GetToolOptionsRequest,
GetToolOptionsResponse,
// Tool state
GetToolStateRequest,
GetToolStateResponse,
// Truncation config
GetTruncationConfigRequest,
GetTruncationConfigResponse,
ListToolsRequest,
ListToolsResponse,
// Output format specs
OutputFieldSpec,
OutputFormat,
OutputFormatSpec,
ResetCompletionStateRequest,
ResetCompletionStateResponse,
ResetToolOptionsRequest,
ResetToolOptionsResponse,
SetSystemRemindersRequest,
SetSystemRemindersResponse,
SetToolOptionsRequest,
SetToolOptionsResponse,
SetToolOverrideRequest,
SetToolOverrideResponse,
SetTruncationConfigRequest,
SetTruncationConfigResponse,
// Streaming types
StreamDataChunk,
StreamDataKind,
StreamFinalResult,
// Capability/metadata types
ToolCapabilities,
ToolCategory,
// Per-tool config entry
ToolConfigEntry,
ToolError,
ToolInfo,
ToolSource,
ToolStreamChunk,
ToolSuccess,
TruncationConfig,
// Version lifecycle warnings
VersionWarning,
AgentCompletionRequirement, AgentToolExecConfig, AgentToolRetryConfig,
ClearToolOverrideRequest, ClearToolOverrideResponse, DisableToolRequest, DisableToolResponse,
EnableToolRequest, EnableToolResponse, ErrorCode, ExecuteToolRequest, ExecuteToolResponse,
ExecutionMetadata, ExecutionOptions, FinalizeAgentRequest, FinalizeAgentResponse,
FinalizeConfigValidationDetails, FinalizeConfigViolation, FinalizeToolServerConfigRequest,
FinalizeToolServerConfigResponse, GetAgentInfoRequest, GetAgentInfoResponse,
GetCompletionStateRequest, GetCompletionStateResponse, GetSystemPromptRequest,
GetSystemPromptResponse, GetSystemRemindersRequest, GetSystemRemindersResponse,
GetToolInfoRequest, GetToolOptionsRequest, GetToolOptionsResponse, GetToolStateRequest,
GetToolStateResponse, GetTruncationConfigRequest, GetTruncationConfigResponse,
ListToolsRequest, ListToolsResponse, OutputFieldSpec, OutputFormat, OutputFormatSpec,
ResetCompletionStateRequest, ResetCompletionStateResponse, ResetToolOptionsRequest,
ResetToolOptionsResponse, SetSystemRemindersRequest, SetSystemRemindersResponse,
SetToolOptionsRequest, SetToolOptionsResponse, SetToolOverrideRequest, SetToolOverrideResponse,
SetTruncationConfigRequest, SetTruncationConfigResponse, StreamDataChunk, StreamDataKind,
StreamFinalResult, ToolCapabilities, ToolCategory, ToolConfigEntry, ToolError, ToolInfo,
ToolSource, ToolStreamChunk, ToolSuccess, TruncationConfig, VersionWarning,
};
/// Default client-facing tool name derived from a namespaced tool id.
@@ -109,9 +48,7 @@ pub fn default_client_name(id: &str) -> &str {
id.split(':').nth(1).unwrap_or(id)
}
/// Convert ToolCategory enum to a string representation.
impl ToolCategory {
/// Get the string representation of the category.
pub fn as_str(&self) -> &'static str {
match self {
Self::Unspecified => "unspecified",