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

chore: Move WebRetriever's new init parameter to last parameter position #5673

Merged
merged 1 commit into from
Aug 29, 2023

Conversation

vblagoje
Copy link
Member

@vblagoje vblagoje commented Aug 29, 2023

Why:

The change aims to minimize the potential for breaking existing clients by moving the new WebRetriever init parameters to the last position. This ensures backward compatibility while introducing new customization options.

What:

Modified the init method of WebRetriever to push allowed_domains and link_content_fetcher as the last parameters in the method signature.

How can it be used:

No changes in usage; two new parameters (allowed_domains and link_content_fetcher) have been added as the last init parameters for optional customization.

How did you test it:

No new unit tests were added. The existing tests should cover the basic functionality. In fact, they should by their own nature test this change. I also reran all WebRetriever examples in examples dir.

Notes For Reviewer:

Please ensure that the new parameters are correctly positioned and that this change doesn't introduce any unintended side effects or break existing functionality.

@vblagoje vblagoje requested a review from a team as a code owner August 29, 2023 13:57
@vblagoje vblagoje requested review from silvanocerza and removed request for a team August 29, 2023 13:57
@vblagoje vblagoje added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Aug 29, 2023
@github-actions github-actions bot added topic:retriever type:documentation Improvements on the docs labels Aug 29, 2023
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 6013272493

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 6 unchanged lines in 1 file lost coverage.
  • Overall coverage remained the same at 48.351%

Files with Coverage Reduction New Missed Lines %
nodes/retriever/web.py 6 92.08%
Totals Coverage Status
Change from base Build 6013155795: 0.0%
Covered Lines: 11496
Relevant Lines: 23776

💛 - Coveralls

@vblagoje
Copy link
Member Author

Seems all good @silvanocerza

Copy link
Contributor

@silvanocerza silvanocerza left a comment

Choose a reason for hiding this comment

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

Perfect, let's go! 🚀

@vblagoje vblagoje merged commit a9b8fd9 into main Aug 29, 2023
52 of 53 checks passed
@vblagoje vblagoje deleted the web_retriever_init_order branch August 29, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:retriever type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants