Skip to content

Check all workspace features and private docs in CI - #1400

Open
Wei Wu (wuw92) wants to merge 1 commit into
mainfrom
wuw92-rustdoc-ci-investigation
Open

Wei Wu (wuw92) wants to merge 1 commit into
mainfrom
wuw92-rustdoc-ci-investigation

Conversation

@wuw92

@wuw92 Wei Wu (wuw92) commented Sep 15, 2026

Copy link
Copy Markdown
Contributor
  • Does this PR have a descriptive title that could go in our release notes?
  • Does this PR add any new dependencies? No.
  • Does this PR modify any existing APIs? No.
  • Is the change to the API backwards compatible? APIs are unchanged.
  • Should this result in any changes to our documentation, either updating existing docs or adding new ones?

Reference Issues/PRs

Refs #1397.

What does this implement/fix? Briefly explain your changes.

The existing docs check covers selected features and checks private documentation only for diskann-inmem, leaving other documentation errors to manual review.

Consolidate it into cargo doc --locked --workspace --no-deps --all-features --document-private-items, retaining -D rustdoc::all and the existing CI gate. Fix the documentation errors exposed by the broader check without changing runtime behavior or API visibility.

Consolidate documentation checks while retaining strict rustdoc lints and the CI gate. Fix documentation errors exposed by the expanded scope, including mixed module documentation that mis-scoped intra-doc links.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@wuw92
Wei Wu (wuw92) requested review from a team and a lite review from Copilot September 15, 2026 02:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No unresolved review issues were identified, and the documentation validation changes are complete.

Pull request overview

This PR expands CI rustdoc validation to the full workspace, all features, and private items, while fixing exposed documentation issues without runtime or API changes.

Changes:

  • Replaces selective checks with workspace-wide private-item documentation validation.
  • Fixes broken links, wording, URLs, formatting, and module documentation.
  • Adds crate-level documentation for the development CLI.
File summaries
File Description
diskann/src/graph/workingset/map.rs Fixed Batch documentation link.
diskann/src/graph/internal/prune.rs Qualified the DiskANNIndex link.
diskann/src/graph/index.rs Updated insertion and scratch-state documentation.
diskann/src/error/ranked.rs Corrected error API references.
diskann-wide/src/reference.rs Formatted the external URL.
diskann-wide/src/arch/x86_64/macros.rs Qualified ZipUnzip links.
diskann-wide/src/arch/mod.rs Corrected architecture terminology.
diskann-record/src/save/context.rs Fixed the SaveContext link.
diskann-record/src/load/context.rs Fixed the Handle link.
diskann-quantization/src/product/tables/transposed/pivots.rs Corrected the SquaredL2 name.
diskann-quantization/src/matrix_kernels/ptr.rs Corrected safety references and punctuation.
diskann-quantization/src/bits/distances.rs Fixed architecture link formatting.
diskann-quantization/src/algorithms/heap.rs Formatted the external URL.
diskann-providers/src/storage/bin.rs Fixed documentation punctuation.
diskann-providers/src/model/graph/provider/mod.rs Relocated module documentation.
diskann-providers/src/model/graph/provider/determinant_diversity.rs Restored module context and corrected a function link.
diskann-providers/src/model/graph/provider/async_/postprocess.rs Qualified trait references.
diskann-providers/src/model/graph/provider/async_/inmem/product.rs Removed invalid trait links.
diskann-providers/src/model/graph/provider/async_/inmem/full_precision.rs Corrected post-processing documentation.
diskann-label-filter/src/encoded_attribute_provider/ast_label_id_mapper.rs Qualified the store reference.
diskann-label-filter/src/encoded_attribute_provider/ast_id_expr.rs Qualified the AST reference.
diskann-disk/src/utils/instrumentation/timer/linux.rs Formatted URLs and paths.
diskann-disk/src/search/provider/disk_sector_graph.rs Corrected inline code formatting.
diskann-disk/src/search/provider/aligned_file_reader/platform/windows/file_io.rs Formatted API links.
diskann-bftree/src/vectors.rs Fixed punctuation.
diskann-benchmark-runner/src/internal/regression.rs Corrected the associated type name.
diskann-benchmark-runner/dev/main.rs Added crate-level documentation.
diskann-benchmark-core/src/search/ids.rs Corrected the type name.
.github/workflows/ci.yml Added comprehensive workspace documentation checks.
Review details
  • Files reviewed: 29/29 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.66%. Comparing base (cc473fc) to head (f2996bd).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1400   +/-   ##
=======================================
  Coverage   92.65%   92.66%           
=======================================
  Files         527      527           
  Lines      103254   103254           
=======================================
+ Hits        95674    95676    +2     
+ Misses       7580     7578    -2     
Flag Coverage Δ
miri 92.66% <ø> (+<0.01%) ⬆️
unittests 92.60% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
diskann-benchmark-core/src/search/ids.rs 97.98% <ø> (ø)
...iskann-benchmark-runner/src/internal/regression.rs 98.11% <ø> (ø)
diskann-bftree/src/vectors.rs 89.58% <ø> (ø)
...kann-disk/src/search/provider/disk_sector_graph.rs 97.34% <ø> (ø)
...kann-disk/src/utils/instrumentation/timer/linux.rs 86.66% <ø> (ø)
...lter/src/encoded_attribute_provider/ast_id_expr.rs 93.78% <ø> (ø)
.../encoded_attribute_provider/ast_label_id_mapper.rs 97.41% <ø> (ø)
...odel/graph/provider/async_/inmem/full_precision.rs 81.89% <ø> (ø)
...s/src/model/graph/provider/async_/inmem/product.rs 91.07% <ø> (ø)
...ers/src/model/graph/provider/async_/postprocess.rs 100.00% <ø> (ø)
... and 15 more

... and 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants