fix(docs): clear 9 rustdoc errors blocking nix flake check on develop#181
Merged
Conversation
`cargo doc --workspace --no-deps` with `RUSTDOCFLAGS=-D warnings` (what `flake.nix`'s `doc` check runs) was failing on develop after PR #175 with 9 rustdoc errors across 3 crates: - `broken_intra_doc_links` on 10 module references inside `rograg/mod.rs` (8 feature-gated submodules) and `storage/mod.rs` (2 feature-gated submodules) — these resolve only when the `rograg` / `surrealdb-storage` / `incremental` features are on, so the default-feature doc build cannot follow them. Switched the doc list to plain code spans (no brackets) so the references stay human-readable without claiming to be intra-doc links. - `invalid_html_tags` on `Vec<f32>` (`graphrag-core/src/vector/mod.rs`) and `Box<T>` (`graphrag-core/src/core/traits.rs`) — the angle-bracket generics were being parsed as HTML tags. Wrapped in backticks. - `broken_intra_doc_links` on `[mode]` in `graphrag-core/src/lib.rs`, referring to a TOML section name — wrapped in backticks to stop rustdoc treating it as a link target. - `bare_urls` on the WebLLM URL in `graphrag-wasm/src/webllm.rs` and the HippoRAG arxiv URL in `graphrag-core/src/retrieval/hipporag_ppr.rs` — wrapped in `<...>`. - `invalid_html_tags` on `<file>` / `<name>` and the literal `[filter]` token in `graphrag-cli/src/commands/mod.rs`'s slash-command examples — wrapped each placeholder in backticks. Verified locally on Rust 1.95.0 (matches the nix toolchain): RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps cargo clippy --workspace --all-targets --no-deps -- -D warnings cargo fmt --all --check All three pass. Co-Authored-By: Claude Opus 4.7 (1M context) <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
2 participants
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
develop'snix-checkjob has been failing on thedocflake checksince shortly after PR #175 merged. Run 26513135868
is the latest example.
The failures are not clippy — they're
cargo doc --workspace --no-depswith
RUSTDOCFLAGS=-D warnings(whatflake.nix'sdoccheck runs).9 rustdoc errors across 3 crates and 7 files:
graphrag-core/src/rograg/mod.rs(8) andgraphrag-core/src/storage/mod.rs(2)that don't exist in the default-feature doc build, plus
[mode]ingraphrag-core/src/lib.rsreferring to a TOML section name.Vec<f32>ingraphrag-core/src/vector/mod.rs,Box<T>ingraphrag-core/src/core/traits.rs, and<file>/<name>/[filter]in
graphrag-cli/src/commands/mod.rs's slash-command examples.graphrag-wasm/src/webllm.rsand theHippoRAG arxiv URL in
graphrag-core/src/retrieval/hipporag_ppr.rs.Fixes are mechanical (backticks for code,
<...>for URLs, drop linkbrackets on feature-gated paths). No code logic changes. 8 files, +20/-20.
Test plan
RUSTDOCFLAGS=\"-D warnings\" cargo doc --workspace --no-deps— passes locally on Rust 1.95.0cargo clippy --workspace --all-targets --no-deps -- -D warnings— passes locallycargo fmt --all --check— passes locallynix-checkjob goes green on this PRToolchain matches the CI flake (Rust 1.95.0).
🤖 Generated with Claude Code