Skip to content

Commit 4411083

Browse files
authored
Fix docstrings (#2794)
1 parent 6ed273d commit 4411083

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • integrations/valkey/src/haystack_integrations/document_stores/valkey

integrations/valkey/src/haystack_integrations/document_stores/valkey/document_store.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ def __init__(
181181
:param embedding_dim: Dimension of document embeddings. Defaults to 768.
182182
:param metadata_fields: Dictionary mapping metadata field names to Python types for filtering.
183183
Supported types: str (for exact matching), int (for numeric comparisons).
184-
Example: {"category": str, "priority": int}.
184+
Example: `{"category": str, "priority": int}`.
185185
If not provided, no metadata fields will be indexed for filtering.
186186
"""
187187
self._index_name = index_name
@@ -1037,7 +1037,7 @@ def _parse_documents_from_ft(raw: Any, *, with_embedding: bool) -> list[Document
10371037
10381038
:param raw: Raw search results from Valkey FT.SEARCH command. Expected format is a list where
10391039
raw[0] is the total count (int) and raw[1] is a dict mapping document keys to field dictionaries
1040-
containing b"payload", b"vector", and b"__vector_score" as byte keys.
1040+
containing `b"payload"`, `b"vector"`, and `b"__vector_score"` as byte keys.
10411041
:param with_embedding: Whether to include embeddings in parsed documents.
10421042
:return: List of Document objects with scores and optional embeddings.
10431043
"""

0 commit comments

Comments
 (0)