Update parition_pdf docstring (#2292)

add `extract_element_types` to partition_pdf docstring and reword other parameter descriptions
Unstructured-IO · Dec 19, 2023 · 09f86f2 · 09f86f2
1 parent 0c7f64e
commit 09f86f2
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-## 0.11.6-dev0
+## 0.11.6-dev1
 
 ### Enhancements
 

diff --git a/unstructured/__version__.py b/unstructured/__version__.py
@@ -1 +1 @@
-__version__ = "0.11.6-dev0"  # pragma: no cover
+__version__ = "0.11.6-dev1"  # pragma: no cover
diff --git a/unstructured/partition/pdf.py b/unstructured/partition/pdf.py
@@ -169,11 +169,15 @@ def partition_pdf(
     metadata_last_modified
         The last modified date for the document.
     extract_images_in_pdf
-        If True and strategy=hi_res, any detected images will be saved in the path specified by
+        Only applicable if `strategy=hi_res`.
+        If `True`, any detected images will be saved in the path specified by
         image_output_dir_path.
+    extract_element_types
+        Only applicable if `strategy=hi_res`.
+        Images of the element type(s) defined in this list will be saved to `image_output_dir_path`.
     image_output_dir_path
-        If extract_images_in_pdf=True and strategy=hi_res, any detected images or tables
-        will be saved in the given path
+        Only applicable if `strategy=hi_res`.
+        The path for saving images when using `extract_images_in_pdf` or `extract_element_types`.
     """
 
     exactly_one(filename=filename, file=file)