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:
ZacharyZhang-NY committed 2026-07-23 16:55:39 -04:00
1 parent ff0fb56c67
commit a02b555e66
1458 files changed
+10729 -21750

No files matched your search

+3 -5
View File
@@ -5,10 +5,8 @@
use std::collections::HashMap;
/// OAuth configuration extracted from an MCP server's config.
///
/// Travels alongside `acp::McpServer` (which can't be extended since it's
/// an external crate type). Keyed by server name in [`McpOAuthConfigMap`].
/// Travels alongside `acp::McpServer` rather than inside it, because that is an
/// external crate type and can't carry extra fields.
#[derive(Debug, Clone, Default)]
pub struct McpOAuthConfig {
pub client_id: Option<String>,
@@ -23,5 +21,5 @@ impl McpOAuthConfig {
}
}
/// Per-server OAuth configuration map, keyed by MCP server name.
/// Keyed by MCP server name.
pub type McpOAuthConfigMap = HashMap<String, McpOAuthConfig>;