Repository navigation
docs: fix intra-doc links to private items; gate rustdoc warnings in CI - #107
Merged
Merged
Conversation
Public docs for scheme::bit2_w6 and the ct_bench module linked to crate-private items (scheme::decompose, the Z2Hash alias, oblivious::reference::build), so cargo doc warned and the links were dead on docs.rs. Name them as plain code spans instead, and add a CI step that runs cargo doc with -D warnings.
There was a problem hiding this comment.
🟢 Approval recommended
The focused documentation corrections and CI gate match the stated purpose, with no unresolved issues identified.
0 open findings
What changed in this PR
Fixes public documentation links to private items and adds a CI guard against rustdoc warnings.
Changes:
- Replaces four private-item links with plain code spans.
- Runs
cargo doc --no-deps --all-featuresin CI with warnings treated as errors.
| File | Description |
|---|---|
packages/ore-rs/src/scheme/bit2_w6.rs |
Corrects three documentation references to private items. |
packages/ore-rs/src/lib.rs |
Replaces the private reference-builder link with a code span. |
.github/workflows/test.yml |
Adds the rustdoc warning gate. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
freshtonic
approved these changes
Oct 16, 2026
freshtonic
left a comment
freshtonic
left a comment
Contributor
There was a problem hiding this comment.
Docs and CI only. No change to code that runs, so there is no security effect.
- The three broken links now point to crate-private items as plain code spans, and the text still describes them correctly.
- I ran
RUSTDOCFLAGS=-D warnings cargo doc --no-deps --all-featureson this head: clean. With--document-private-items: also clean. - The new CI step covers the whole workspace with
--all-features, so it also checks the feature-gatedct_benchdocs.
🤖 Generated with Claude Code
This was referenced Oct 16, 2026
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
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
cargo docgave 4 warnings: public docs linked to private items, so the links didn't work on docs.rs.scheme::bit2_w6module docs: linked tocrate::scheme::decompose(pub(crate)) and to the privateZ2Hashtype alias.OreAes128Bit6::encrypt_left: linked tocrate::scheme::decompose.ct_bench::fy_swaps_only: linked tooblivious::reference::build(private).These are now plain code spans that say the items are crate-private. The PR also adds a CI
docsstep that runscargo doc --no-deps --all-featureswithRUSTDOCFLAGS=-D warnings, so this can't come back unnoticed.Verification
cargo docpasses with-D warningsfor bothore-rsandorderable-bytes.--document-private-items: also clean.