change documentation link to repository link#1156
Open
harsha-simhadri wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Rust crate metadata so crates.io can link documentation to docs.rs (by removing the incorrect documentation field pointing at GitHub) while still providing a proper source link via repository.
Changes:
- Replaced
documentation.workspace = truewithrepository.workspace = trueacross published workspace crates. - Updated
[workspace.package]metadata to setrepository = "https://github.com/microsoft/DiskANN"(instead ofdocumentation). - Normalized
diskann-benchmark-core’s workspace-inherited package fields to the.workspace = truestyle while making the same metadata correction.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Cargo.toml | Switch workspace package metadata from documentation to repository so crates.io can use docs.rs for docs links. |
| diskann/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-wide/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-vector/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-utils/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-tools/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-quantization/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-providers/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-platform/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-linalg/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-label-filter/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-disk/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-benchmark/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-benchmark-simd/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-benchmark-runner/Cargo.toml | Inherit repository from workspace instead of documentation. |
| diskann-benchmark-core/Cargo.toml | Convert workspace-inherited fields to dotted form and inherit repository (not documentation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
32eeb41 to
23bc9f9
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1156 +/- ##
=======================================
Coverage 89.46% 89.46%
=======================================
Files 487 487
Lines 92106 92106
=======================================
+ Hits 82401 82406 +5
+ Misses 9705 9700 -5
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.
changes equivalent to #1115, which may not merge until CLA is accepted