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
+1 -13
View File
@@ -242,7 +242,7 @@ fn extract_model_metadata(headers: &reqwest::header::HeaderMap) -> Option<Respon
/// `stream_options` fields without modifying the original `ChatCompletionRequest`.
///
/// Uses `#[serde(flatten)]` to inline all fields from the inner request,
/// allowing single-pass serialization instead of the previous two-pass
/// allowing single-pass serialization instead of a two-pass
/// approach (serialize to `Value`, mutate, serialize to bytes).
#[derive(Serialize)]
struct StreamingChatRequest<'a> {
@@ -309,9 +309,7 @@ struct ClientDefaults {
openai_codex: bool,
}
// =============================================================================
// User-Agent helpers
// =============================================================================
#[derive(Clone, Debug, Eq, PartialEq)]
struct PlatformInfo {
@@ -378,9 +376,7 @@ pub fn user_agent_string_for(origin: &OriginClientInfo) -> String {
}
}
// =============================================================================
// SamplingClient
// =============================================================================
impl SamplingClient {
/// Construct a sampling client from a [`SamplerConfig`].
@@ -888,9 +884,7 @@ impl SamplingClient {
Ok(completion)
}
// =========================================================================
// Chat Completions API
// =========================================================================
pub async fn chat_completion(
&self,
@@ -1113,9 +1107,7 @@ impl SamplingClient {
Ok((chunks, model_metadata))
}
// =========================================================================
// Responses API
// =========================================================================
/// Apply default configuration to a Responses API request.
fn apply_response_defaults(&self, request: &mut CreateResponseWrapper) -> Result<()> {
@@ -1479,9 +1471,7 @@ impl SamplingClient {
Ok((events, model_metadata, doom_loop))
}
// =========================================================================
// Anthropic Messages API
// =========================================================================
/// Apply default configuration to a Messages API request.
fn apply_message_defaults(&self, request: &mut MessagesRequestWrapper) -> Result<()> {
@@ -1771,9 +1761,7 @@ impl SamplingClient {
Ok((events, model_metadata))
}
// =========================================================================
// Unified Conversation API
// =========================================================================
/// Apply default configuration to a ConversationRequest.
fn apply_conversation_defaults(&self, request: &mut ConversationRequest) -> Result<()> {