Skip to content

DeepDocs: Docs updates triggered by 47f4728 in unstructured/main#1

Open
deepdocsai-dev[bot] wants to merge 1 commit into
mainfrom
deepdocs-update/main
Open

DeepDocs: Docs updates triggered by 47f4728 in unstructured/main#1
deepdocsai-dev[bot] wants to merge 1 commit into
mainfrom
deepdocs-update/main

Conversation

@deepdocsai-dev

@deepdocsai-dev deepdocsai-dev Bot commented Apr 5, 2026

Copy link
Copy Markdown

Docs Scan Report

  • Docs Scan was initialized in unstructured@main
  • 7 docs were found to be outdated
Docs Reason
cleaning.mdx Line 98 The example output omits the preserved exclamation mark from the input string after applying clean with bullets=True and lowercase=True. [Ref: function clean in core.py]
Line 156 The example output omits the preserved exclamation mark from the input string after applying clean_non_ascii_chars. [Ref: function clean_non_ascii_chars in core.py]
Lines 322:325 Examples use incorrect function name 'replace_unicode_characters' instead of 'replace_unicode_quotes'; second output comment has malformed quotes. [Ref: function replace_unicode_quotes in core.py]
extracting.mdx Lines 256:259 Examples use incorrect function name 'replace_unicode_characters' instead of 'replace_unicode_quotes'; second output comment has malformed quotes. [Ref: function replace_unicode_quotes in core.py]
partitioning.mdx Line 192 partition_email does not accept raw text input or include_headers parameter (removed); header information is always captured in element metadata [Ref: function partition_email in email.py]
Lines 207:227 partition_email does not accept text or include_headers parameters; file requires binary mode "rb" (expects IO[bytes] not text IO); removed invalid examples and fixed file mode [Ref: function partition_email in email.py]
Lines 374:378 partition_msg does not accept content_source parameter; max_partition always applies (no conditional on text/plain) [Ref: function partition_msg in msg.py]
Lines 273:280 partition_html(file=...) expects IO[bytes] so file must be opened in binary "rb" mode, not text "r" mode [Ref: function partition_html in partition.py]
Lines 612:619 partition_text(file=...) expects IO[bytes] so file must be opened in binary "rb" mode, not text "r" mode [Ref: function partition_text in text.py]
Line 13 partition_csv supports options like encoding, include_header, infer_table_structure (not "None") [Ref: function partition_csv in csv.py]
Line 17 partition_xlsx supports options like find_subtable, include_header, infer_table_structure (not "None") [Ref: function partition_xlsx in xlsx.py]
Line 18 partition_html supports encoding but not include_page_breaks [Ref: function partition_html in partition.py]
Line 248 typo: pandocs should be pandoc [Ref: function partition_epub in epub.py]
Line 576 code block missing language specifier python [Ref: function partition_rst in rst.py]
text-as-html.mdx Line 11 text_as_html is an HTML-formatted string within the element's metadata, not a JSON object [Ref: function supplement_element_with_table_extraction in ocr.py]
pinecone.mdx Line 11 This documentation page is for the Pinecone destination connector, but incorrectly refers to a 'source connector'.
Line 23 This documentation page is for the Pinecone destination connector, but incorrectly refers to a 'source connector'.
ingest-cli.mdx Line 30 Documented default API URL 'https://api.unstructuredapp.io/general/v0/general' does not match the default 'https://api.unstructured.io/general/v0/general' in partition_via_api and partition_multiple_via_api [Ref: function partition_via_api in api.py, function partition_multiple_via_api in api.py]
python-ingest.mdx Line 42 Documented default API URL 'https://api.unstructuredapp.io/general/v0/general' does not match the default 'https://api.unstructured.io/general/v0/general' in partition_via_api and partition_multiple_via_api [Ref: function partition_via_api in api.py, function partition_multiple_via_api in api.py]

Credits
Used: 1
Remaining: 99/100

- open-source/core-functionality/cleaning.mdx: The example output omits the preserved exclamation mark from the input string after applying clean with bullets=True and lowercase=True. | The example output omits the preserved exclamation mark from the input string after applying clean_non_ascii_chars. | Examples use incorrect function name 'replace_unicode_characters' instead of 'replace_unicode_quotes'; second output comment has malformed quotes.
- open-source/core-functionality/extracting.mdx: Examples use incorrect function name 'replace_unicode_characters' instead of 'replace_unicode_quotes'; second output comment has malformed quotes.
- open-source/core-functionality/partitioning.mdx: partition_email does not accept raw `text` input or `include_headers` parameter (removed); header information is always captured in element metadata | `partition_email` does not accept `text` or `include_headers` parameters; `file` requires binary mode "rb" (expects `IO[bytes]` not text IO); removed invalid examples and fixed file mode | `partition_msg` does not accept `content_source` parameter; `max_partition` always applies (no conditional on text/plain) | `partition_html(file=...)` expects `IO[bytes]` so file must be opened in binary "rb" mode, not text "r" mode | `partition_text(file=...)` expects `IO[bytes]` so file must be opened in binary "rb" mode, not text "r" mode | `partition_csv` supports options like `encoding`, `include_header`, `infer_table_structure` (not "None") | `partition_xlsx` supports options like `find_subtable`, `include_header`, `infer_table_structure` (not "None") | `partition_html` supports `encoding` but not `include_page_breaks` | typo: `pandocs` should be `pandoc` | code block missing language specifier `python`
- open-source/how-to/text-as-html.mdx: `text_as_html` is an HTML-formatted string within the element's metadata, not a JSON object
- open-source/ingestion/destination-connectors/pinecone.mdx: This documentation page is for the Pinecone destination connector, but incorrectly refers to a 'source connector'. | This documentation page is for the Pinecone destination connector, but incorrectly refers to a 'source connector'.
- open-source/ingestion/ingest-cli.mdx: Documented default API URL 'https://api.unstructuredapp.io/general/v0/general' does not match the default 'https://api.unstructured.io/general/v0/general' in partition_via_api and partition_multiple_via_api
- open-source/ingestion/python-ingest.mdx: Documented default API URL 'https://api.unstructuredapp.io/general/v0/general' does not match the default 'https://api.unstructured.io/general/v0/general' in partition_via_api and partition_multiple_via_api
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants