Skip to content

Incosistency in HybridQuery class description #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
paololazzari opened this issue Apr 7, 2025 · 1 comment · Fixed by #314
Closed

Incosistency in HybridQuery class description #313

paololazzari opened this issue Apr 7, 2025 · 1 comment · Fixed by #314
Assignees
Labels
bug Something isn't working

Comments

@paololazzari
Copy link
Contributor

We're generating markdown docs using a Sphinx extension.

I noticed that the .. code-block:: python bit has a leading space. This results in an incorrectly formatted markdown file.

class HybridQuery(AggregationQuery):
"""
HybridQuery combines text and vector search in Redis.
It allows you to perform a hybrid search using both text and vector similarity.
It scores documents based on a weighted combination of text and vector similarity.
.. code-block:: python

compared to the correct:

class TextQuery(BaseQuery):
"""
TextQuery is a query for running a full text search, along with an optional filter expression.
.. code-block:: python

@tylerhutcherson tylerhutcherson self-assigned this Apr 7, 2025
@tylerhutcherson tylerhutcherson added the bug Something isn't working label Apr 7, 2025
@tylerhutcherson
Copy link
Collaborator

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants