fix(docs): clear all rustdoc errors under -D warnings#191
Merged
Conversation
Full-workspace audit (cargo doc --document-private-items + RUSTDOCFLAGS=-D warnings) turned up 16+ unresolved-link / unclosed-HTML-tag errors. None are runtime bugs but they break the published rustdoc: - 2 fresh errors from PR #190's snapshot_vmstate_only doc comment: `[snapshot_to]` / `[snapshot_diff_to]` intra-doc links didn't resolve because rustdoc needs the `Self::` prefix when pointing at sibling methods. Use `Self::snapshot_to`. - 11+ pre-existing errors in crates/forkd-cli/src/main.rs: angle-bracketed CLI placeholders (`<name>`, `<path>`, `<file>`, `<sanitized-tag>`, `<image-slug>`, `<tag>`) were treated as unclosed HTML tags. Wrap the affected subcommand-listing block in a `text` code fence; individually backtick the remaining placeholders in arg docs (`/tmp/forkd-parent-<tag>/`, `~/.local/share/forkd/snapshots/<tag>/`, etc.). - 1 error: bare `[:ro]` after `HOST_FILE:GUEST_PATH` parsed as an intra-doc link with empty target. Wrap the whole format string in backticks. - 1 error: bare `https://forkd-hub.deeplethe.com.` got flagged "this URL is not a hyperlink". Wrap in angle brackets so rustdoc treats it as an autolink. - 1 error: `[`DESIGN-v0.4.md`]` in the kvm-uffd-wp PoC was a dangling intra-doc link. Switch to plain prose reference. - 1 error: angle brackets in hub.rs MetaJson doc comment for parent_tag. Verified: `cargo doc -D warnings` exit 0, fmt/clippy/test all still pass (85 tests, 0 failures).
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.
Summary
Full-workspace audit (`cargo doc --document-private-items` + `RUSTDOCFLAGS=-D warnings`) turned up 16+ errors. None are runtime bugs but they break the published rustdoc — clicking any of the broken intra-doc links gives a 404, and the angle-bracketed CLI placeholders render as raw `` text.
Categories fixed:
DESIGN-v0.4.md\\]` in v0.4 PoC — switch to plain prose.Test plan