docstring

deepset-ai · Dec 21, 2023 · 6e1b743 · 6e1b743
1 parent da7a09e
commit 6e1b743
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/haystack/components/converters/html.py b/haystack/components/converters/html.py
@@ -55,8 +55,11 @@ def run(self, sources: List[Union[str, Path, ByteStream]], meta: Optional[List[D
         Converts a list of HTML files to Documents.
 
         :param sources: List of HTML file paths or ByteStream objects.
-        :param meta: Optional list of metadata to attach to the Documents.
-          The length of the list must match the number of sources. Defaults to `None`.
+        :param meta: Optional metadata to attach to the Documents.
+          This value can be either a list of dictionaries or a single dictionary.
+          If it's a single dictionary, its content is added to the metadata of all produced Documents.
+          If it's a list, the length of the list must match the number of sources, because the two lists will be zipped.
+          Defaults to `None`.
         :return: A dictionary containing a list of Document objects under the 'documents' key.
         """