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

Feature/add docs #198

Merged
merged 2 commits into from
Mar 24, 2024
Merged

Feature/add docs #198

merged 2 commits into from
Mar 24, 2024

Conversation

emrgnt-cmplxty
Copy link
Contributor

@emrgnt-cmplxty emrgnt-cmplxty commented Mar 24, 2024

Ellipsis 🚀 This PR description was created by Ellipsis for commit 42bd470.

Summary:

This PR adds comprehensive documentation for the core features of the application and modifies the _parse_html method in the BasicIngestionPipeline class.

Key points:

  • Added documentation for the Ingestion, Embedding, RAG, Evaluation, and Factory pipelines in the /docs/pages/core-features/ directory.
  • Modified the _parse_html method in the BasicIngestionPipeline class to expect a bytes object instead of a string.

Generated with ❤️ by ellipsis.dev

@emrgnt-cmplxty emrgnt-cmplxty merged commit 6169a50 into main Mar 24, 2024
2 checks passed
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested.

  • Reviewed the entire pull request up to 42bd470
  • Looked at 594 lines of code in 7 files
  • Took 53 seconds to review
More info
  • Skipped 0 files when reviewing.
  • Skipped posting 0 additional comments because they didn't meet confidence threshold of 50%.

Workflow ID: wflow_D2GTweVahq3VPWzu


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. We'll respond in a few minutes. Learn more here.

return self._parse_html(entry_data)
if not isinstance(entry_data, bytes):
raise ValueError("HTML data must be a bytes object.")
return self._parse_html(entry_data.encode("utf-8"))
Copy link
Contributor

Choose a reason for hiding this comment

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

The condition for the HTML entry type is incorrect. It checks if entry_data is a bytes object and then attempts to encode it to utf-8. This will raise an error because bytes objects do not need to be encoded. The condition should check if entry_data is a str object and then encode it to utf-8.

Suggested change
return self._parse_html(entry_data.encode("utf-8"))
if not isinstance(entry_data, str):
raise ValueError("HTML data must be a string.")
return self._parse_html(entry_data.encode("utf-8"))

@emrgnt-cmplxty emrgnt-cmplxty deleted the feature/add-docs branch March 24, 2024 06:39
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.

1 participant