Devicemxl docstrings enhancing 1 #191
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
Updated docstrings for clarity and added details about the embedding computation process.
Added docstrings to SearchResult and PassageManager classes, detailing their attributes and methods.
Updated docstring to clarify candidate path resolution priority and added comments for better understanding.
Added detailed docstrings for the LeannBuilder class and its methods, explaining their purpose and parameters.
Added detailed docstrings to the LeannSearcher class methods for better understanding and usage. Improved logging docstrings.
Added docstrings to methods for better clarity and understanding of their functionality.
Collaborator
|
Thanks for adding docstrings! However, there are a few issues that need to be fixed before we can merge: 1. Syntax Error: Double docstringdef get_registered_backends() -> list[str]:
"""Get list of registered backend names."""
"""
Retrieves the installed and registered search backends.
...
"""Two consecutive docstrings is a syntax error - the second one becomes a dead string literal. Please remove the duplicate or merge them into one. 2. Spanish comments mixed inPlease use English consistently throughout. Found Spanish comments like:
3. Inconsistent comment styleSome inline comments are in English, some in Spanish. Please unify to English. Once these are fixed, we'd be happy to merge. Thanks for your contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What does this PR do?
docstrings enhancing
Related Issues
Fixes # docstrings enhancing