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
@@ -4,9 +4,8 @@ use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::{ConnectionId, ConnectionKind, ServerId, UserId};
|
||||
|
||||
/// Wire-protocol version both ends speak. Bumped when an incompatible
|
||||
/// schema change lands; minor additions go through capability
|
||||
/// negotiation rather than a version bump.
|
||||
/// Bumped only for incompatible schema changes; additive changes go through
|
||||
/// capability negotiation instead.
|
||||
pub const PROTOCOL_VERSION: &str = "1.0.0";
|
||||
|
||||
/// First frame sent by the client after the WebSocket upgrade succeeds.
|
||||
@@ -14,15 +13,13 @@ pub const PROTOCOL_VERSION: &str = "1.0.0";
|
||||
/// No session ids are carried at handshake time. The connection starts with
|
||||
/// an empty bound-session set and binds sessions dynamically over its
|
||||
/// lifetime via `register_session` / `unregister_session` JSON-RPC calls.
|
||||
///
|
||||
/// Tool-server connections carry `server_id` so the hub can
|
||||
/// identify the server without a separate `register_server` call.
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
pub struct HelloMsg {
|
||||
pub protocol_version: String,
|
||||
pub kind: ConnectionKind,
|
||||
/// Stable server identity. Only set for
|
||||
/// [`ConnectionKind::ToolServer`] connections.
|
||||
/// Stable server identity, set only for [`ConnectionKind::ToolServer`]
|
||||
/// connections, so the hub can identify the server without a separate
|
||||
/// `register_server` call.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub server_id: Option<ServerId>,
|
||||
/// One-line server description for `servers.list`.
|
||||
|
||||
Reference in new issue
Block a user