Skip to content

[doc] Fix lots of little typos in diskann-wide - #771

Merged
Mark Hildebrand (hildebrandmw) merged 5 commits into
mainfrom
users/mhildebr/typos
Feb 12, 2026
Merged

[doc] Fix lots of little typos in diskann-wide#771
Mark Hildebrand (hildebrandmw) merged 5 commits into
mainfrom
users/mhildebr/typos

Conversation

@hildebrandmw

Copy link
Copy Markdown
Contributor

Fix various typos, outdated safety comments, and inaccuracies.

This is almost entirely documentation only, with a few error messages containing typo fixes as well.

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 fixes numerous typos, outdated safety comments, and inaccuracies in the diskann-wide crate documentation. The changes are almost entirely documentation-only, with a few error messages and safety comments also corrected. Additionally, several intrinsic feature requirements have been corrected to match Intel's intrinsics guide specifications.

Changes:

  • Fixed spelling and grammar errors throughout documentation (e.g., "dereferencable" → "dereferenceable", "than" → "then", "correponsing" → "corresponding")
  • Corrected intrinsic CPU feature requirements (SSE3 → SSSE3 for abs instructions, AVX2 → AVX for some conversions, AVX2 → AVX512BW+AVX512VL for i16 shifts)
  • Improved safety comments by replacing vague "Gated by CFG" comments with specific feature requirements
  • Fixed incorrect type descriptions in code comments (e.g., "32-bit floating point" → "32-bit signed integer" for integer SIMD types)

Reviewed changes

Copilot reviewed 59 out of 59 changed files in this pull request and generated no comments.

Show a summary per file
FileDescription
diskann-wide/src/traits.rsFixed typos in trait documentation (dereferenceable, numeric, bitmask, etc.) and corrected doc comment for none() method
diskann-wide/src/test_utils/*.rsFixed typos in test utility documentation and comments
diskann-wide/src/splitjoin.rsMinor grammar fix in doc comment
diskann-wide/src/lifetime.rsFixed typos in module documentation ("funtion" → "function", "limitations the" → "limitations in the")
diskann-wide/src/lib.rsFixed path typo and removed outdated doc comment
diskann-wide/src/emulated.rsMultiple typo fixes and corrected type descriptions in comments
diskann-wide/src/arch/x86_64/v4/*.rsCorrected intrinsic feature requirements, fixed type descriptions, improved NaN check comments, and fixed various typos
diskann-wide/src/arch/x86_64/v3/*.rsSimilar corrections as v4: intrinsic features, safety comments, type descriptions
diskann-wide/src/arch/x86_64/{mod,macros,common,algorithms}.rsFixed typos in comments and improved safety documentation
diskann-wide/src/arch/emulated/mod.rsFixed "compattible" → "compatible" typo

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov-commenter

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

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.98%. Comparing base (ea4078e) to head (5400182).

Files with missing linesPatch %Lines
diskann-wide/src/arch/x86_64/v3/mod.rs0.00%1 Missing ⚠️
diskann-wide/src/arch/x86_64/v4/mod.rs0.00%1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@## main #771 +/- ##
==========================================
- Coverage 90.29% 88.98% -1.31% 
==========================================
Files 428 428 Lines 78420 78420 ==========================================
- Hits 70809 69785 -1024 - Misses 7611 8635 +1024 
FlagCoverage Δ
miri88.98% <33.33%> (-1.31%)⬇️
unittests88.98% <33.33%> (-1.31%)⬇️

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

Files with missing linesCoverage Δ
diskann-wide/src/arch/emulated/mod.rs100.00% <ø> (ø)
diskann-wide/src/arch/mod.rs83.79% <ø> (-5.03%)⬇️
diskann-wide/src/arch/x86_64/algorithms.rs100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/common.rs66.66% <ø> (-33.34%)⬇️
diskann-wide/src/arch/x86_64/macros.rs55.84% <ø> (-44.16%)⬇️
diskann-wide/src/arch/x86_64/mod.rs91.62% <ø> (+1.47%)⬆️
diskann-wide/src/arch/x86_64/v3/conversion.rs100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f16x16_.rs100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f16x8_.rs100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f32x4_.rs100.00% <ø> (ø)
... and 49 more

... and 10 files with indirect coverage changes

🚀 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 e093583 into mainFeb 12, 2026
28 checks passed
@hildebrandmw
Mark Hildebrand (hildebrandmw) deleted the users/mhildebr/typos branch February 12, 2026 16:56
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.

5 participants

@hildebrandmw@codecov-commenter@metajack@harsha-simhadri