Skip to content

Commit 17eb56c

Browse files
fix(docs): drop private intra-doc links
ci-checks' `cargo doc -D warnings` step failed: `rustdoc::private_intra_doc_links` — public docs for `allowed_hosts`, `spawn_with`, and the `doctor` module linked to private items (`validate`, `stderr_pump`, the cmd_doctor check submodules). Converted the intra-doc links to plain code spans; wording and the public API are unchanged. Caught by /release-checks (clippy + tests were green but rustdoc was not run by the feature agents).
1 parent edb219b commit 17eb56c

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

crates/mcp-loadtest-cli/src/cmd_doctor/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
//!
99
//! Split across submodules to stay under the 300-line production cap and to
1010
//! keep each check independently unit-testable:
11-
//! - [`python`] — Python interpreter on PATH
12-
//! - [`server`] — MCP server `initialize` smoke (only with `--server`)
13-
//! - [`runs`] — stale `runs/` accumulation
14-
//! - [`toolchain`] — Windows MSVC-vs-GNU mismatch
11+
//! - `python` — Python interpreter on PATH
12+
//! - `server` — MCP server `initialize` smoke (only with `--server`)
13+
//! - `runs` — stale `runs/` accumulation
14+
//! - `toolchain` — Windows MSVC-vs-GNU mismatch
1515
//!
1616
//! See [ADR 0014](../../../docs/adr/0014-error-hints-explain-doctor.md).
1717

crates/mcp-loadtest/src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ pub struct ServerConfig {
9595
/// loopback / link-local IP literals are always blocked unless the exact
9696
/// literal is listed here (operator escape hatch, e.g. `"127.0.0.1"` for
9797
/// local testing). No wildcard / suffix matching — entries must be bare
98-
/// hostnames (no scheme / port / path); validated by [`validate`].
98+
/// hostnames (no scheme / port / path); validated at config load.
9999
#[serde(default)]
100100
pub allowed_hosts: Vec<String>,
101101
}

crates/mcp-loadtest/src/protocol/transport/stdio.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ impl StdioTransport {
9999
///
100100
/// For the capture/tee modes a background pump task drains the piped
101101
/// stderr; it is cancellation-aware and joined on shutdown so the file is
102-
/// flushed (see [`stderr_pump`]).
102+
/// flushed (see the `stderr_pump` submodule).
103103
///
104104
/// `kill_on_drop(true)` ensures a panicking parent doesn't leave zombie
105105
/// children behind.

0 commit comments

Comments
 (0)