[components] Improve docstring of PDFDocument's _element_indexes_with…

…_fonts()
jstockwin · May 4, 2020 · 0ff19e8 · 0ff19e8
1 parent 7bbf686
commit 0ff19e8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/py_pdf_parser/components.py b/py_pdf_parser/components.py
@@ -451,6 +451,8 @@ def get_page(self, page_number: int) -> "PDFPage":
     def _element_indexes_with_fonts(self, *fonts: str) -> Set[int]:
         """
         Returns all the indexes of elements with given fonts.
+        For internal use only, used to cache fonts. If you want to filter by fonts you
+        should use elements.filter_by_fonts instead.
 
         Args:
             *fonts (str): The fonts to filter for.