fix(docs): correct docstrings for find_similar in Descriptors#678
Merged
Conversation
Release 0.4.56
Release 0.4.57
Release 0.4.58
ad-claw000
force-pushed
the
fix/542-fix-docstring-find-similar
branch
from
d24f56a to
1941503
Compare
ad-claw000
commented
May 20, 2026
Contributor
Author
ad-claw000
left a comment
ad-claw000
left a comment
There was a problem hiding this comment.
Applied autopep8 formatting to the new log messages to fix the pre-commit CI failure.
luisremis
previously approved these changes
May 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Descriptors object wrapper documentation to correct the wording around find_similar / find_similar_mmr, aligning the description of the input vector with descriptor (not descriptor set) usage, per issue #542.
Changes:
- Adjusted
find_similardocstring to describe searching for similar descriptors and corrected thevectorparameter description. - Adjusted
find_similar_mmrdocstring to correct thevectorparameter description.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
luisremis
approved these changes
May 20, 2026
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.
Closes #542.
The docstrings for
find_similarandfind_similar_mmrincorrectly referred to the input vector as 'Input descriptor set vector'. This PR fixes it to 'Input descriptor vector'.