[doc] Fix lots of little typos in diskann-wide#771
Conversation
There was a problem hiding this comment.
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
| File | Description |
|---|---|
| diskann-wide/src/traits.rs | Fixed typos in trait documentation (dereferenceable, numeric, bitmask, etc.) and corrected doc comment for none() method |
| diskann-wide/src/test_utils/*.rs | Fixed typos in test utility documentation and comments |
| diskann-wide/src/splitjoin.rs | Minor grammar fix in doc comment |
| diskann-wide/src/lifetime.rs | Fixed typos in module documentation ("funtion" → "function", "limitations the" → "limitations in the") |
| diskann-wide/src/lib.rs | Fixed path typo and removed outdated doc comment |
| diskann-wide/src/emulated.rs | Multiple typo fixes and corrected type descriptions in comments |
| diskann-wide/src/arch/x86_64/v4/*.rs | Corrected intrinsic feature requirements, fixed type descriptions, improved NaN check comments, and fixed various typos |
| diskann-wide/src/arch/x86_64/v3/*.rs | Similar corrections as v4: intrinsic features, safety comments, type descriptions |
| diskann-wide/src/arch/x86_64/{mod,macros,common,algorithms}.rs | Fixed typos in comments and improved safety documentation |
| diskann-wide/src/arch/emulated/mod.rs | Fixed "compattible" → "compatible" typo |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 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
Fix various typos, outdated safety comments, and inaccuracies.
This is almost entirely documentation only, with a few error messages containing typo fixes as well.