Skip to content

Fix spelling errors in streaming API documentation - #715

Merged
Mark Hildebrand (hildebrandmw) merged 5 commits into
mainfrom
copilot/sub-pr-714
Feb 5, 2026
Merged

Fix spelling errors in streaming API documentation#715
Mark Hildebrand (hildebrandmw) merged 5 commits into
mainfrom
copilot/sub-pr-714

Conversation

CopilotAI commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

Fixes three spelling errors in the public documentation of diskann-benchmark-core/src/streaming/api.rs:

  • Line 16: "maintance" → "maintenance"
  • Line 71: "exector" → "executor"
  • Line 74: "aggreate" → "aggregate"

These corrections improve the quality of user-facing documentation.

Changes Made

  • Fixed spelling error in Stream trait documentation: "maintance" → "maintenance"
  • Fixed spelling error in Executor trait documentation: "exector" → "executor"
  • Fixed spelling error in Executor trait documentation: "aggreate" → "aggregate"

Testing

  • ✅ Rust compilation passes (cargo check -p diskann-benchmark-core)
  • ✅ Code review completed with no issues found

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.

CopilotAI changed the title [WIP] Create issue to address feedback on roll-up PRProvide issue details for spelling errors in streaming API docsFeb 4, 2026
Base automatically changed from mhildebr/sync-squashed to mainFebruary 4, 2026 17:26
@hildebrandmw

Copy link
Copy Markdown
Contributor

Copilot - Please rebase this PR.

CopilotAI commented Feb 4, 2026

Copy link
Copy Markdown
ContributorAuthor

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.

@hildebrandmw

Copy link
Copy Markdown
Contributor

Copilot - Can you do a merge commit with main instead?

CopilotAI commented Feb 4, 2026

Copy link
Copy Markdown
ContributorAuthor

Copilot - Can you do a merge commit with main instead?

Done. Merged main into this branch with commit e6f2270.

@hildebrandmw

Copy link
Copy Markdown
Contributor

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>

CopilotAI commented Feb 4, 2026

Copy link
Copy Markdown
ContributorAuthor

Copilot - This PR now no longer fixes the identified spelling errors. Can you fix this please?

Fixed all three spelling errors in commit 140d7e8:

  • "maintance" → "maintenance"
  • "exector" → "executor"
  • "aggreate" → "aggregate"

CopilotAI 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.

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.

CopilotAI changed the title Provide issue details for spelling errors in streaming API docsFix spelling errors in streaming API documentationFeb 4, 2026
@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Feb 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.01%. Comparing base (d9d6ce2) to head (140d7e8).
⚠️ Report is 63 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@## main #715 +/- ##
=======================================
Coverage 89.01% 89.01% =======================================
Files 428 428 Lines 78151 78151 =======================================
Hits 69563 69563 Misses 8588 8588 
Files with missing linesCoverage Δ
diskann-benchmark-core/src/streaming/api.rs98.37% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hildebrandmw
Mark Hildebrand (hildebrandmw) merged commit 5c6cdba into mainFeb 5, 2026
15 checks passed
@hildebrandmw
Mark Hildebrand (hildebrandmw) deleted the copilot/sub-pr-714 branch February 5, 2026 23:27
Mark Hildebrand (hildebrandmw) added a commit that referenced this pull request Feb 13, 2026
## 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
Sign up for freeto 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.

6 participants

@hildebrandmw@codecov-commenter@harsha-simhadri@suhasjs