Skip to content

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

Merged
hildebrandmw merged 5 commits intomainfrom
users/mhildebr/typos
Feb 12, 2026
Merged

[doc] Fix lots of little typos in diskann-wide#771
hildebrandmw merged 5 commits intomainfrom
users/mhildebr/typos

Conversation

@hildebrandmw
Copy link
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.

Copy link
Contributor

Copilot AI left a comment

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
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-commenter
Copy link

codecov-commenter commented Feb 12, 2026

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 lines Patch % Lines
diskann-wide/src/arch/x86_64/v3/mod.rs 0.00% 1 Missing ⚠️
diskann-wide/src/arch/x86_64/v4/mod.rs 0.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     
Flag Coverage Δ
miri 88.98% <33.33%> (-1.31%) ⬇️
unittests 88.98% <33.33%> (-1.31%) ⬇️

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

Files with missing lines Coverage Δ
diskann-wide/src/arch/emulated/mod.rs 100.00% <ø> (ø)
diskann-wide/src/arch/mod.rs 83.79% <ø> (-5.03%) ⬇️
diskann-wide/src/arch/x86_64/algorithms.rs 100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/common.rs 66.66% <ø> (-33.34%) ⬇️
diskann-wide/src/arch/x86_64/macros.rs 55.84% <ø> (-44.16%) ⬇️
diskann-wide/src/arch/x86_64/mod.rs 91.62% <ø> (+1.47%) ⬆️
diskann-wide/src/arch/x86_64/v3/conversion.rs 100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f16x16_.rs 100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f16x8_.rs 100.00% <ø> (ø)
diskann-wide/src/arch/x86_64/v3/f32x4_.rs 100.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 hildebrandmw merged commit e093583 into main Feb 12, 2026
28 checks passed
@hildebrandmw hildebrandmw deleted the users/mhildebr/typos branch February 12, 2026 16:56
Sign up for free to 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.

4 participants