update docstring

deepsense-ai · Oct 30, 2024 · 29a5e55 · 29a5e55
1 parent d375bfb
commit 29a5e55
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/ragbits-document-search/src/ragbits/document_search/documents/element.py b/packages/ragbits-document-search/src/ragbits/document_search/documents/element.py
@@ -64,11 +64,12 @@ def from_vector_db_entry(cls, db_entry: VectorStoreEntry) -> "Element":
 
     def add_location_metadata(self, provider_metadata: dict) -> "Element":
         """
-        Add metadata retrived by provider to document metadata.
+        Add metadata retrived by provider to element.
 
         Args:
             provider_metadata: metadata retrived by provider or null.
-
+        Returns:
+            an instance of updated Element
         """
         page_number = provider_metadata.get("page_number")
         coordinates = provider_metadata.get("coordinates")