Fix spelling errors in streaming API documentation#715
Conversation
|
@copilot - Please rebase this PR. |
I don't have the ability to perform git rebase operations as they require force push capabilities. You'll need to rebase this PR manually or grant me additional permissions to handle branch operations. |
|
@copilot - Can you do a merge commit with |
|
@copilot - This PR now no longer fixes the identified spelling errors. Can you fix this please? |
Co-authored-by: hildebrandmw <24898651+hildebrandmw@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR corrects three spelling errors in the documentation comments for the streaming API in the DiskANN benchmark core module. The changes address feedback from a previous review requesting issue details for these spelling errors.
Changes:
- Fixed spelling error: "maintance" → "maintenance" in the Stream trait documentation
- Fixed spelling error: "exector" → "executor" in the Executor trait documentation
- Fixed spelling error: "aggreate" → "aggregate" in the Executor trait documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #715 +/- ##
=======================================
Coverage 89.01% 89.01%
=======================================
Files 428 428
Lines 78151 78151
=======================================
Hits 69563 69563
Misses 8588 8588
🚀 New features to boost your workflow:
|
## What's Changed ### API Breaking Changes * Remove the `experimental_avx512` feature. by @hildebrandmw in #732 * Use VirtualStorageProvider::new_overlay(test_data_root()) in tests by @Copilot in #726 * save and load max_record_size and leaf_page_size for bftrees by @backurs in #724 * [multi-vector] Verify `Standard` won't overflow in its constructor. by @hildebrandmw in #757 * VirtualStorageProvider: Make new() private, add new_physical by @Copilot in #764 * [minmax] Refactor full query by @arkrishn94 in #770 * Bump diskann-quantization to edition 2024. by @hildebrandmw in #772 ### Additions * [multi-vector] Enable cloning of `Mat` and friends. by @hildebrandmw in #759 * adding bftreepaths in mod.rs by @backurs in #775 * [quantization] Add `as_raw_ptr`. by @hildebrandmw in #774 ### Bug Fixes * Fix `diskann` compilation without default-features and add CI tests. by @hildebrandmw in #722 ### Docs and Comments * Updating the benchmark README to use diskann-benchmark by @bryantower in #709 * Fix doc comment: Windows line endings are \r\n not \n\r by @Copilot in #717 * Fix spelling errors in streaming API documentation by @Copilot in #715 * Add performance diagnostic to `diskann-benchmark` by @hildebrandmw in #744 * Add agents.md onboarding guide for coding agents by @Copilot in #765 * [doc] Fix lots of little typos in `diskann-wide` by @hildebrandmw in #771 ### Performance * [diskann-wide] Optimize `load_simd_first` for 8-bit and 16-bit element types. by @hildebrandmw in #747 ### Dependencies * Bump bytes from 1.11.0 to 1.11.1 by @dependabot[bot] in #723 * [diskann] Add note on the selection of `PruneKind` in `graph::config::Builder`. by @hildebrandmw in #734 * [diskann-providers] Remove the LRU dependency and make `vfs` and `serde_json` optional. by @hildebrandmw in #733 ### Infrastructure * Add initial QEMU tests for `diskann-wide`. by @hildebrandmw in #719 * [CI] Skip coverage for Dependabot. by @hildebrandmw in #725 * Add miri test coverage to CI workflow by @Copilot in #729 * [CI] Add minimal ARM checks by @hildebrandmw in #745 * Enable CodeQL security analysis by @Copilot in #754 ## New Contributors * @backurs made their first contribution in #724 * @arkrishn94 made their first contribution in #770 **Full Changelog**: 0.45.0...0.46.0
Fixes three spelling errors in the public documentation of
diskann-benchmark-core/src/streaming/api.rs:These corrections improve the quality of user-facing documentation.
Changes Made
Streamtrait documentation: "maintance" → "maintenance"Executortrait documentation: "exector" → "executor"Executortrait documentation: "aggreate" → "aggregate"Testing
cargo check -p diskann-benchmark-core)The changes are documentation-only and do not affect functionality.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.