DeepDocs: Docs updates triggered by 47f4728 in unstructured/main#1
Open
deepdocsai-dev[bot] wants to merge 1 commit into
Open
DeepDocs: Docs updates triggered by 47f4728 in unstructured/main#1deepdocsai-dev[bot] wants to merge 1 commit into
deepdocsai-dev[bot] wants to merge 1 commit into
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs Scan Report
cleanin 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_charsin 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_quotesin core.py]replace_unicode_quotesin core.py]textinput orinclude_headersparameter (removed); header information is always captured in element metadata [Ref: functionpartition_emailin email.py]• Lines 207:227
partition_emaildoes not accepttextorinclude_headersparameters;filerequires binary mode "rb" (expectsIO[bytes]not text IO); removed invalid examples and fixed file mode [Ref: functionpartition_emailin email.py]• Lines 374:378
partition_msgdoes not acceptcontent_sourceparameter;max_partitionalways applies (no conditional on text/plain) [Ref: functionpartition_msgin msg.py]• Lines 273:280
partition_html(file=...)expectsIO[bytes]so file must be opened in binary "rb" mode, not text "r" mode [Ref: functionpartition_htmlin partition.py]• Lines 612:619
partition_text(file=...)expectsIO[bytes]so file must be opened in binary "rb" mode, not text "r" mode [Ref: functionpartition_textin text.py]• Line 13
partition_csvsupports options likeencoding,include_header,infer_table_structure(not "None") [Ref: functionpartition_csvin csv.py]• Line 17
partition_xlsxsupports options likefind_subtable,include_header,infer_table_structure(not "None") [Ref: functionpartition_xlsxin xlsx.py]• Line 18
partition_htmlsupportsencodingbut notinclude_page_breaks[Ref: functionpartition_htmlin partition.py]• Line 248 typo:
pandocsshould bepandoc[Ref: functionpartition_epubin epub.py]• Line 576 code block missing language specifier
python[Ref: functionpartition_rstin rst.py]text_as_htmlis an HTML-formatted string within the element's metadata, not a JSON object [Ref: functionsupplement_element_with_table_extractionin ocr.py]• Line 23 This documentation page is for the Pinecone destination connector, but incorrectly refers to a 'source connector'.
partition_via_apiin api.py, functionpartition_multiple_via_apiin api.py]partition_via_apiin api.py, functionpartition_multiple_via_apiin api.py]Credits
Used: 1
Remaining: 99/100