fix(docs): resolve the 5 pre-existing rustdoc warnings

cargo doc --no-deps was not actually clean before review 007's
remediation — it emitted 5 warnings that went uncounted (grep for
"^error|^warning" in the gate runs matched only on error/warning at
line start, and the review baselines recorded "clean" without a
counting check; the warnings were first noticed while re-verifying
the review-007 gate set). All pre-existing, none introduced by
review 007:

- src/adapters/mod.rs: the bare [`OpenAPISpec`] intra-doc link did
  not resolve (the re-export sits in the same module, but rustdoc
  resolves module-level links against the module's own scope) —
  spelled out as `openapi_spec::OpenAPISpec`
- src/websocket/mod.rs: [`upgrade`] did not resolve from the
  `websocket` module doc (the submodule is not in scope for the
  parent's doc links) — plain `upgrade`
- src/websocket/upgrade.rs:215: [`CallConnection`] had no import in
  scope — spelled out via the full alkcall path
- src/websocket/upgrade.rs:291: [`install_channel_zero`] linked a
  private item from public docs — plain `install_channel_zero` hook
- src/server/adapter.rs:274: [`crate::websocket::OpenHandler`] is
  not re-exported from `websocket` — spelled out via the alkcall
  path

Verification: cargo doc --no-deps 0 warnings (was 5); cargo test 454
passed / 0 failed; cargo test --all-features 587 passed / 0 failed;
clippy (both configs) clean; fmt clean.

Review: docs/reviews/007-ws-data-channel-surface-review.md (the
baseline's "cargo doc → clean" claim was wrong on this dimension)
This commit is contained in:
glm-5.3-flash committed 2026-09-05 05:59:54 +00:00
1 parent 802d94ec07
commit 2e15204aca
4 files changed
+9 -6

No files matched your search

+2 -2
View File
@@ -5,8 +5,8 @@
//!
//! Feature sides: the `from_*` import adapters compile under `client`;
//! `to_openapi` / `to_mcp` under `server`; the shared
//! [`OpenAPISpec`] document model under `openapi` (implied by both
//! sides).
//! `openapi_spec::OpenAPISpec` document model under `openapi`
//! (implied by both sides).
#[cfg(any(feature = "client", all(feature = "server", feature = "openapi")))]
pub mod input_validation;
+2 -1
View File
@@ -271,7 +271,8 @@ impl HttpAdapter {
/// Unit 2): one [`OpenableAlpn`](crate::websocket::OpenableAlpn)
/// per openable data-channel ALPN — the open-op spec (with the
/// `channel_open` marker) and the ALPN-specific
/// [`OpenHandler`](crate::websocket::OpenHandler). Each WS
/// [`OpenHandler`](alkcall::channels::operations::OpenHandler).
/// Each WS
/// session's per-session fork registers the set (plus the generic
/// channel ops, bootstrap discovery, and `op/register`), so a WS
/// client can open data channels exactly as any channels consumer
+1 -1
View File
@@ -9,7 +9,7 @@
//! alkcall's byte-oriented channels machinery — shared with the
//! `from_wss` consumer path ([ADR-070]).
//!
//! Feature sides: [`upgrade`] (and the axum flavor of the adapter)
//! Feature sides: `upgrade` (and the axum flavor of the adapter)
//! compile under `server`; the tungstenite flavor compiles under `wss`
//! (and under `test-support`); both are available with both features.
+4 -2
View File
@@ -212,7 +212,9 @@ impl WsSessions {
self.sessions.lock().is_empty()
}
/// The live session's channel-0 [`CallConnection`] handles (WS-26):
/// The live session's channel-0
/// [`CallConnection`](alkcall::protocol::connection::CallConnection)
/// handles (WS-26):
/// the deployment-visible surface the assembly layer (or the hub)
/// reaches browser/session-side ops through — connection-local
/// overlay composition, `announce_op`-style pushes, session
@@ -288,7 +290,7 @@ impl OpenableAlpn {
/// progress. `write_timeout` bounds one outbound WS send (WS-18):
/// `None` = the crate default window, `Some(d)` a deployment-set
/// window. `openable_alpns` (WS-22) is the deployment's openable-ALPN
/// set registered per session (see [`install_channel_zero`]).
/// set registered per session (see the `install_channel_zero` hook).
/// `op_register_acl` (review 007 WS-29) is the `op/register`
/// surface's `AccessControl` — `AccessControl::default()` (the
/// permissive crate default) unless a deployment restricts which