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: adjust docstrings in the audio package #7246

Merged
merged 4 commits into from
Feb 28, 2024
Merged

Conversation

masci
Copy link
Contributor

@masci masci commented Feb 28, 2024

Related Issues

Proposed Changes:

Adjust the docstrings to the Haystack convention. Also improved a bit the content.

How did you test it?

Notes for the reviewer

Checklist

@masci masci added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Feb 28, 2024
@masci masci requested a review from a team as a code owner February 28, 2024 14:26
@masci masci requested review from anakin87 and removed request for a team February 28, 2024 14:26
@github-actions github-actions bot added 2.x Related to Haystack v2.0 type:documentation Improvements on the docs labels Feb 28, 2024
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 to merge after some minor changes.

haystack/components/audio/whisper_remote.py Outdated Show resolved Hide resolved
haystack/components/audio/whisper_remote.py Outdated Show resolved Hide resolved
haystack/components/audio/whisper_remote.py Outdated Show resolved Hide resolved
@coveralls
Copy link
Collaborator

coveralls commented Feb 28, 2024

Pull Request Test Coverage Report for Build 8083846830

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 41 unchanged lines in 5 files lost coverage.
  • Overall coverage remained the same at 90.091%

Files with Coverage Reduction New Missed Lines %
components/websearch/searchapi.py 2 96.36%
dataclasses/document.py 3 93.81%
components/audio/whisper_local.py 6 91.3%
components/audio/whisper_remote.py 13 69.77%
components/websearch/serper_dev.py 17 69.84%
Totals Coverage Status
Change from base Build 8081267643: 0.0%
Covered Lines: 5264
Relevant Lines: 5843

💛 - Coveralls

Co-authored-by: Stefano Fiorucci <[email protected]>
@masci masci merged commit 890c613 into main Feb 28, 2024
20 checks passed
@masci masci deleted the massi/audio-docstrings branch February 28, 2024 17:22
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.

Docstrings - haystack.components.audio
3 participants