While reading the public docs against the current Rust API, I found a few small docs drifts:
docs/api.md says Python bit_width is in {2, 4}, but the constructors accept {2, 3, 4} and the tests cover 3-bit.
- The file format section still describes an older layout:
.tv starts at the 9-byte header and .tvim says version 1. Current io.rs writes TVPI / TVIM magic, version 3, per-vector scales, and the TQ+ trailer.
- The README Rust snippets call
TurboQuantIndex::new and IdMapIndex::new without handling the Result.
Why it matters:
These are small docs bugs, but they can confuse new users trying the public API or reading saved index files.
I have a tiny docs-only change ready in my fork:
gabrielemidulla@07b9605
It updates only README.md and docs/api.md.
Validation:
cargo test -p turbovec --doc
2 passed, 0 failed
If this direction looks useful, happy to open the PR. Can I get contributor access for this issue?
While reading the public docs against the current Rust API, I found a few small docs drifts:
docs/api.mdsays Pythonbit_widthis in{2, 4}, but the constructors accept{2, 3, 4}and the tests cover 3-bit..tvstarts at the 9-byte header and.tvimsays version 1. Currentio.rswritesTVPI/TVIMmagic, version 3, per-vector scales, and the TQ+ trailer.TurboQuantIndex::newandIdMapIndex::newwithout handling theResult.Why it matters:
These are small docs bugs, but they can confuse new users trying the public API or reading saved index files.
I have a tiny docs-only change ready in my fork:
gabrielemidulla@07b9605
It updates only
README.mdanddocs/api.md.Validation:
If this direction looks useful, happy to open the PR. Can I get contributor access for this issue?