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

docs: adding missing docstrings for run and run_batch methods #5609

Merged
merged 8 commits into from
Oct 13, 2023

Conversation

dfokina
Copy link
Contributor

@dfokina dfokina commented Aug 21, 2023

Related Issues

Proposed Changes:

  • Added docstrings for missing run and run_batch methods in several nodes.

How did you test it?

Notes for the reviewer

Checklist

@dfokina dfokina requested a review from a team as a code owner August 21, 2023 19:26
@dfokina dfokina requested review from vblagoje and removed request for a team August 21, 2023 19:26
@dfokina dfokina added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Aug 21, 2023
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Good job!

I noticed some small aspects to improve...

haystack/nodes/document_classifier/base.py Outdated Show resolved Hide resolved
haystack/nodes/document_classifier/base.py Outdated Show resolved Hide resolved
haystack/nodes/image_to_text/base.py Outdated Show resolved Hide resolved
haystack/nodes/image_to_text/base.py Outdated Show resolved Hide resolved
haystack/nodes/ranker/base.py Outdated Show resolved Hide resolved
haystack/nodes/ranker/base.py Outdated Show resolved Hide resolved
haystack/nodes/retriever/base.py Outdated Show resolved Hide resolved
haystack/nodes/summarizer/base.py Outdated Show resolved Hide resolved
haystack/nodes/translator/base.py Outdated Show resolved Hide resolved
@dfokina
Copy link
Contributor Author

dfokina commented Oct 10, 2023

@anakin87 Also, black tests keep failing with each commit, what can I do with that?

@anakin87
Copy link
Member

@anakin87 Also, black tests keep failing with each commit, what can I do with that?

Two alternative solutions (the first is better)

@anakin87 anakin87 self-requested a review October 12, 2023 10:16
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Left only a small comment. (Not sure if relevant)

Once the tests are green, we can merge this!

@anakin87
Copy link
Member

I tried to fix black errors.

@coveralls
Copy link
Collaborator

coveralls commented Oct 13, 2023

Pull Request Test Coverage Report for Build 6506193085

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 141 unchanged lines in 9 files lost coverage.
  • Overall coverage decreased (-0.004%) to 50.557%

Files with Coverage Reduction New Missed Lines %
utils/context_matching.py 1 95.7%
nodes/summarizer/base.py 4 60.0%
nodes/image_to_text/base.py 6 41.67%
nodes/ranker/base.py 9 85.53%
nodes/answer_generator/base.py 17 54.88%
nodes/translator/base.py 17 30.95%
nodes/document_classifier/base.py 18 32.79%
nodes/retriever/base.py 28 39.56%
nodes/reader/base.py 41 29.17%
Totals Coverage Status
Change from base Build 6505906098: -0.004%
Covered Lines: 12795
Relevant Lines: 25308

💛 - Coveralls

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:images topic:reader topic:retriever type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants