documentation fix

Guest400123064 · May 2, 2024 · e54dc75 · e54dc75
1 parent 2e6e7d0
commit e54dc75
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/bbm25_haystack/bbm25_retriever.py b/src/bbm25_haystack/bbm25_retriever.py
@@ -105,9 +105,11 @@ def run(
         :type query: ``str``
         :param filters: Haystack filters, a dictionary with filters to
             narrow down the search space. The filters are applied
-            **before** similarity retrieval.
+            **before** similarity retrieval. Use the value provided during
+            initialization if not specified.
         :type filters: ``Optional[dict[str, Any]]``
-        :param top_k: The maximum number of documents to return.
+        :param top_k: The maximum number of documents to return. Use the
+            value provided during initialization if not specified.
         :type top_k: ``Optional[int]``
 
         :return: The retrieved documents in a dictionary with key "documents".