fix(docs): repair broken intra-doc links under -D warnings#144
Conversation
The Documentation workflow runs `cargo doc --workspace --no-deps`
with `RUSTDOCFLAGS=-D warnings`, which turns
`rustdoc::broken_intra_doc_links` and
`rustdoc::private_intra_doc_links` into hard errors. The v2.1.20
tree had five such links:
- esp32_native.rs module docs linked `Esp32Deployer::use_native_{verify,write}`
as bare paths. The struct lives in the sibling `esp32` module and
the fields are private — switched both links to the public builder
methods `super::esp32::Esp32Deployer::with_native_{verify,write}`.
- `try_write_deployment_native` linked private `LoggingProgressBridge`
from a public doc comment. Dropped the link (kept the code-span
name) since the bridge is an impl detail.
- log_layer.rs module docs linked bare `BroadcastHub::log_tx`.
`BroadcastHub` lives in `crate::context` — fully qualified.
- fast_path.rs field doc linked bare `hash_watch_set_stamps`. The
function lives one module up and wasn't imported — switched to
`super::hash_watch_set_stamps`.
Verified with `RUSTDOCFLAGS="-D warnings" uv run cargo doc --workspace --no-deps`.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 24 minutes and 3 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Summary
The Documentation workflow (runs/24624181584, job/72000122089) failed on main because
cargo doc --workspace --no-depswithRUSTDOCFLAGS=-D warningspromotesrustdoc::broken_intra_doc_linksandrustdoc::private_intra_doc_linksto errors. Five links in the v2.1.20 tree were broken:crates/fbuild-deploy/src/esp32_native.rs:38,40— linked bareEsp32Deployer::use_native_{verify,write}. The struct is in the siblingesp32module and the fields are private. Switched both to the public builder methods on the fully qualified path:super::esp32::Esp32Deployer::with_native_{verify,write}.crates/fbuild-deploy/src/esp32_native.rs:233— public fntry_write_deployment_nativelinked privateLoggingProgressBridge. Dropped the link (kept the code-span name) — the bridge is an impl detail, not part of the public surface.crates/fbuild-daemon/src/log_layer.rs:2— linked bareBroadcastHub::log_tx. The type lives incrate::context. Fully qualified.crates/fbuild-build/src/build_fingerprint/fast_path.rs:114— linked barehash_watch_set_stamps. The function is one module up (super::hash_watch_set_stamps) and wasn't imported intofast_path. Qualified.Test plan
RUSTDOCFLAGS="-D warnings" uv run cargo doc --workspace --no-deps— clean, no errors or warnings🤖 Generated with Claude Code