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: Update Reader's doc strings #6312

Merged
merged 3 commits into from
Nov 24, 2023
Merged

Docs: Update Reader's doc strings #6312

merged 3 commits into from
Nov 24, 2023

Conversation

agnieszka-m
Copy link
Contributor

@agnieszka-m agnieszka-m commented Nov 15, 2023

Related Issues

  • fixes #issue-number

Proposed Changes:

How did you test it?

Notes for the reviewer

I changed "confidence score" to "probability score" everywhere because the field in the answer object is actually called "probability". I believe Julian already opened a PR to change the "confidence score threshold" param to "probability threshold" as well.

Checklist

@agnieszka-m agnieszka-m requested a review from a team as a code owner November 15, 2023 13:32
@agnieszka-m agnieszka-m requested review from vblagoje and removed request for a team November 15, 2023 13:32
@github-actions github-actions bot added 2.x Related to Haystack v2.0 type:documentation Improvements on the docs labels Nov 15, 2023
@agnieszka-m
Copy link
Contributor Author

the warm_up() method doesn't have any description - can we add this?

@agnieszka-m agnieszka-m added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Nov 15, 2023
Copy link
Member

@vblagoje vblagoje left a comment

Choose a reason for hiding this comment

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

LGTM and ready to 🚢

@masci masci merged commit 27cf8ee into main Nov 24, 2023
20 checks passed
@masci masci deleted the reader-docstrings branch November 24, 2023 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Related to Haystack v2.0 ignore-for-release-notes PRs with this flag won't be included in the release notes. type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants