Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unstructured: review docstrings #531

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Unstructured: review docstrings #531

merged 2 commits into from
Mar 4, 2024

Conversation

anakin87
Copy link
Member

@anakin87 anakin87 commented Mar 4, 2024

@github-actions github-actions bot added integration:unstructured-fileconverter type:documentation Improvements or additions to documentation labels Mar 4, 2024
Comment on lines +64 to +67
`"one-doc-per-file"`: One Haystack Document per file. All elements are concatenated into one text field.
`"one-doc-per-page"`: One Haystack Document per page.
All elements on a page are concatenated into one text field.
`"one-doc-per-element"`: One Haystack Document per element. Each element is converted to a Haystack Document.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bulleted lists inside a specific parameter do not play well with pydoc-markdown

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this should've been an enum instead of a string literal. We should open an issue to convert this (later).

@anakin87 anakin87 marked this pull request as ready for review March 4, 2024 14:39
@anakin87 anakin87 requested a review from a team as a code owner March 4, 2024 14:39
@anakin87 anakin87 requested review from shadeMe and removed request for a team March 4, 2024 14:39
Comment on lines +64 to +67
`"one-doc-per-file"`: One Haystack Document per file. All elements are concatenated into one text field.
`"one-doc-per-page"`: One Haystack Document per page.
All elements on a page are concatenated into one text field.
`"one-doc-per-element"`: One Haystack Document per element. Each element is converted to a Haystack Document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this should've been an enum instead of a string literal. We should open an issue to convert this (later).

…/converters/unstructured/converter.py

Co-authored-by: Madeesh Kannan <[email protected]>
@anakin87 anakin87 merged commit de56507 into main Mar 4, 2024
8 checks passed
@anakin87 anakin87 deleted the unstructured-docstrings branch March 4, 2024 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration:unstructured-fileconverter type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docstrings - integrations.unstructured
2 participants