[HZ-5291] Asyncio Client API Docs #764
Open
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #764 +/- ##
==========================================
- Coverage 94.60% 94.60% -0.01%
==========================================
Files 393 393
Lines 25056 25056
==========================================
- Hits 23704 23703 -1
- Misses 1352 1353 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
amandalindsay
approved these changes
Dec 15, 2025
amandalindsay
left a comment
amandalindsay
left a comment
There was a problem hiding this comment.
Just some minor comments and suggestions so approving in advance
| Returns silently if there is no such listener added before. | ||
| Args: | ||
| registration_id: The id of registered listener. |
There was a problem hiding this comment.
Suggested change
| registration_id: The id of registered listener. | |
| registration_id: The id of the registered listener. |
| does not contain this key. | ||
| Warning: | ||
| This method returns a clone of original Document, modifying the |
There was a problem hiding this comment.
Suggested change
| This method returns a clone of original Document, modifying the | |
| This method returns a clone of the original Document. Modifying the |
There was a problem hiding this comment.
'Document' sometimes appears with an initial capital, sometimes without. For consistency, suggest we settle on one, preferably 'document' unless there's a reason it needs to be treated as a proper noun
| Warning: | ||
| This method returns a clone of original Document, modifying the | ||
| returned Document does not change the actual Document in the VectorCollection. One |
There was a problem hiding this comment.
Suggested change
| returned Document does not change the actual Document in the VectorCollection. One | |
| returned Document does not change the actual Document in the VectorCollection. Put |
| Warning: | ||
| This method returns a clone of original Document, modifying the | ||
| returned Document does not change the actual Document in the VectorCollection. One | ||
| should put modified Document back to make changes visible to all nodes. |
There was a problem hiding this comment.
Suggested change
| should put modified Document back to make changes visible to all nodes. | |
| the modified Document back to make changes visible to all nodes. |
| Warning: | ||
| This method uses ``__hash__`` and ``__eq__`` methods of binary form | ||
| of the key, not the actual implementations of ``__hash__`` and | ||
| ``__eq__`` defined in key's class. |
There was a problem hiding this comment.
Suggested change
| ``__eq__`` defined in key's class. | |
| ``__eq__`` defined in the key's class. |
| Warning: | ||
| This method uses ``__hash__`` and ``__eq__`` methods of binary form | ||
| of the key, not the actual implementations of ``__hash__`` and | ||
| ``__eq__`` defined in key's class. |
There was a problem hiding this comment.
Suggested change
| ``__eq__`` defined in key's class. | |
| ``__eq__`` defined in the key's class. |
| ) -> List[SearchResult]: | ||
| """Returns the Documents closest to the given vector. | ||
| The search is performed using distance metric set when |
There was a problem hiding this comment.
Suggested change
| The search is performed using distance metric set when | |
| The search is performed using the distance metric set when |
| Warning: | ||
| This method uses ``__hash__`` and ``__eq__`` methods of binary form | ||
| of the key, not the actual implementations of ``__hash__`` and | ||
| ``__eq__`` defined in key's class. |
There was a problem hiding this comment.
Suggested change
| ``__eq__`` defined in key's class. | |
| ``__eq__`` defined in the key's class. |
| Returns: | ||
| The Document associated with key, or ``None`` if there was | ||
| no mapping for key. |
There was a problem hiding this comment.
Suggested change
| no mapping for key. | |
| no mapping for the key. |
| to the advertised degree, and updating the entry node as necessary. | ||
| Warning: | ||
| This operation can take long time to execute and consume a lot of server resources. |
There was a problem hiding this comment.
Suggested change
| This operation can take long time to execute and consume a lot of server resources. | |
| This operation can take a long time to execute and consume a lot of server resources. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.