[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:
|
Fix various typos, outdated safety comments, and inaccuracies.
This is almost entirely documentation only, with a few error messages containing typo fixes as well.