Repository navigation
feat(python): add editor typing and API documentation - #164
Merged
Merged
Conversation
github-actions
Bot
added
the
release:added
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add public type stubs and NumPy-style docstrings for index and clustering APIs, including signatures, array dtypes, valid options, and examples. Ship the stubs and
py.typedin wheels.Require installed-package typing checks in Python CI and wheel tests. Mypy is a test-only dependency; runtime APIs and index formats are unchanged.
Testing
git diff --check.Skipped tests require the C++ example executable (4) or repaired Linux ARM64/macOS wheels (2). Cross-platform validation remains for PR CI.