Skip to content

Commit f965259

Browse files
committed
fix(benchmarks-website): clean up rustdoc intra-doc-link errors
The Rust (docs) CI job runs `RUSTDOCFLAGS="-D warnings" cargo doc`, which promotes both `broken_intra_doc_links` and `private_intra_doc_links` to errors. The refactor introduced eight new failures from public docs linking to private items and an ambiguous module/function link: - `api/charts.rs` and `api/summary.rs` — module-level `//!` comments linked to private types (`SeriesAccumulator`, `query_group_has_v2_summary`). Drop the link syntax; keep them as plain backticked names. - `html/mod.rs` — module-level `//!` comments linked to `[`render`]`, `[`landing`]`, `[`chart`]`, `[`summary`]`, `[`filter`]`, `[`toolbar`]`, `[`static_assets`]`, but those submodules are crate-private (`mod`, not `pub mod`). Drop the link syntax and call out the privacy in the prose. - `api/mod.rs` — `[`groups`]` was ambiguous because `groups` is both the submodule and the axum handler function. Disambiguate every submodule link in the list with the `mod@` prefix. Verified locally: RUSTDOCFLAGS="-D warnings" cargo doc --no-deps \ -p vortex-bench-server -p vortex-bench-migrate passes cleanly, and `cargo test --profile ci --doc -p vortex-bench-server -p vortex-bench-migrate --all-features --no-fail-fast` runs (zero doctests, zero failures). Signed-off-by: Claude <noreply@anthropic.com>
1 parent 1a39b35 commit f965259

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

benchmarks-website/server/src/api/charts.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-License-Identifier: Apache-2.0
22
// SPDX-FileCopyrightText: Copyright the Vortex contributors
33

4-
//! Per-chart payload assembly + the shared [`SeriesAccumulator`] glue.
4+
//! Per-chart payload assembly + the shared `SeriesAccumulator` glue.
55
//!
66
//! `chart_payload` dispatches on [`ChartKey`] to one of five
77
//! `collect_*_chart` functions, each of which runs one SQL query against

benchmarks-website/server/src/api/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
//! [`crate::slug::ChartKey`] / [`crate::slug::GroupKey`].
1010
//!
1111
//! Submodules:
12-
//! - [`dto`] — every wire-shape struct (`Group`, `ChartResponse`, …).
13-
//! - [`window`] — [`CommitWindow`] + [`ChartQuery`].
14-
//! - [`groups`] — discovery passes that build the group / chart-link tree.
15-
//! - [`summary`] — v2-compatible per-group rollups.
16-
//! - [`charts`] — `chart_payload` + the per-fact-table `collect_*_chart`
12+
//! - [`mod@dto`] — every wire-shape struct (`Group`, `ChartResponse`, …).
13+
//! - [`mod@window`] — [`CommitWindow`] + [`ChartQuery`].
14+
//! - [`mod@groups`] — discovery passes that build the group / chart-link tree.
15+
//! - [`mod@summary`] — v2-compatible per-group rollups.
16+
//! - [`mod@charts`] — `chart_payload` + the per-fact-table `collect_*_chart`
1717
//! functions and their shared `SeriesAccumulator`.
18-
//! - [`filter`] — chip-universe collection for the global filter bar.
18+
//! - [`mod@filter`] — chip-universe collection for the global filter bar.
1919
2020
pub mod charts;
2121
pub mod dto;

benchmarks-website/server/src/api/summary.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//! Each `collect_*_summary` runs a small set of focused SQL queries over a
77
//! single fact table and returns one [`Summary`] variant. The query group
88
//! summary is gated on a v2 dataset allowlist via
9-
//! [`query_group_has_v2_summary`].
9+
//! `query_group_has_v2_summary`.
1010
1111
use std::collections::BTreeMap;
1212
use std::collections::BTreeSet;

benchmarks-website/server/src/html/mod.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@
4040
//! script) are served from `/static/...` via [`include_bytes!`] so the
4141
//! binary is fully self-contained.
4242
//!
43-
//! Submodules:
44-
//! - [`render`] — page chrome (header, theme bootstrap, error page,
43+
//! Submodules (all crate-private):
44+
//! - `render` — page chrome (header, theme bootstrap, error page,
4545
//! `escape_json_for_script`).
46-
//! - [`landing`] — landing-page body + chart-card shell rendering.
47-
//! - [`chart`] — chart and group permalink page bodies.
48-
//! - [`summary`] — group summary card rendering.
49-
//! - [`filter`] — filter dropdown + on-page filter-state JSON.
50-
//! - [`toolbar`] — per-chart scope slider, Y-axis switch, range strip.
51-
//! - [`static_assets`] — `include_bytes!`'d JS/CSS/SVG handlers.
46+
//! - `landing` — landing-page body + chart-card shell rendering.
47+
//! - `chart` — chart and group permalink page bodies.
48+
//! - `summary` — group summary card rendering.
49+
//! - `filter` — filter dropdown + on-page filter-state JSON.
50+
//! - `toolbar` — per-chart scope slider, Y-axis switch, range strip.
51+
//! - `static_assets` — `include_bytes!`'d JS/CSS/SVG handlers.
5252
5353
mod chart;
5454
mod filter;

0 commit comments

Comments
 (0)