Commit f965259
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
44 | | - | |
| 43 | + | |
| 44 | + | |
45 | 45 | | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| |||
0 commit comments