fix(docs): repair intra-doc links the rustdoc gate rejects - #10
Merged
Conversation
The fleet reusable CI workflow added a rustdoc gate
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --workspace --all-features
that this repo had never run. It fails on `main`.
Broken link (1):
- `core/src/backing.rs:33` — [`VhdxReader::open_reader`] on the `ReadSeekSend`
trait docs. `VhdxReader` is not in scope in `backing`; it lives in the private
`reader` module and reaches the public API only through the crate-root
re-export `pub use reader::VhdxReader`. Path corrected to
[`crate::VhdxReader::open_reader`], which is the form that resolves — the
bare name does not, and `crate::reader::VhdxReader` would point at a private
module. Reference form only; wording unchanged.
Control (mandatory): with the fix applied the gate exits 0. Reverting the one
link back to [`VhdxReader::open_reader`] and re-running made the gate fail again
with `error: unresolved link to 'VhdxReader::open_reader' --> core/src/backing.rs:33:37`,
exit 101; the link was then restored and the gate re-confirmed at exit 0. The
gate is proven able to fail for the reason it exists.
No lint was silenced — no `#![allow(rustdoc::broken_intra_doc_links)]` and no
item made public to satisfy a link.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The fleet reusable CI workflow added a rustdoc gate this repo had never run:
It fails on
main. One broken link:core/src/backing.rs:33[`VhdxReader::open_reader`]VhdxReaderis not in scope inbacking; it lives in the privatereadermodule and reaches the public API only via the crate-root re-exportpub use reader::VhdxReader[`crate::VhdxReader::open_reader`]Reference form only — no prose meaning changed, no lint silenced, nothing made
pubto satisfy a link.Control. With the fix applied the gate exits 0. Reverting the link and
re-running made it fail again —
error: unresolved link to 'VhdxReader::open_reader' --> core/src/backing.rs:33:37, exit 101 — then the link was restored and the gatere-confirmed at exit 0. Also green locally:
cargo fmt --check,cargo clippy --workspace --all-features --all-targets -- -D warnings,cargo test --workspace --all-features.🤖 Generated with Claude Code