github/nzbToMedia
1
0
Fork 0
mirror of https://github.com/clinton-hall/nzbToMedia.git synced 2025-08-21 22:03:13 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix docstrings

Browse source
This commit is contained in:
Clinton Hall 2024-03-01 15:18:44 +13:00 • committed by GitHub
commit 3243ce32d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
libs/common/subliminal/core.py
View file

@ -535,7 +535,7 @@ def refine(video, episode_refiners=None, movie_refiners=None, refiner_configs=No
:param tuple movie_refiners: refiners to use for movies. :param tuple movie_refiners: refiners to use for movies.
:param dict refiner_configs: refiner configuration as keyword arguments per refiner name to pass when :param dict refiner_configs: refiner configuration as keyword arguments per refiner name to pass when
calling the refine method calling the refine method
:param \*\*kwargs: additional parameters for the :func:`~subliminal.refiners.refine` functions. :param **kwargs: additional parameters for the :func:`~subliminal.refiners.refine` functions.
""" """
refiners = () refiners = ()
@ -562,7 +562,7 @@ def list_subtitles(videos, languages, pool_class=ProviderPool, **kwargs):
:type languages: set of :class:`~babelfish.language.Language` :type languages: set of :class:`~babelfish.language.Language`
:param pool_class: class to use as provider pool. :param pool_class: class to use as provider pool.
:type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar :type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar
:param \*\*kwargs: additional parameters for the provided `pool_class` constructor. :param **kwargs: additional parameters for the provided `pool_class` constructor.
:return: found subtitles per video. :return: found subtitles per video.
:rtype: dict of :class:`~subliminal.video.Video` to list of :class:`~subliminal.subtitle.Subtitle` :rtype: dict of :class:`~subliminal.video.Video` to list of :class:`~subliminal.subtitle.Subtitle`
@ -599,7 +599,7 @@ def download_subtitles(subtitles, pool_class=ProviderPool, **kwargs):
:type subtitles: list of :class:`~subliminal.subtitle.Subtitle` :type subtitles: list of :class:`~subliminal.subtitle.Subtitle`
:param pool_class: class to use as provider pool. :param pool_class: class to use as provider pool.
:type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar :type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar
:param \*\*kwargs: additional parameters for the provided `pool_class` constructor. :param **kwargs: additional parameters for the provided `pool_class` constructor.
""" """
with pool_class(**kwargs) as pool: with pool_class(**kwargs) as pool:
@ -625,7 +625,7 @@ def download_best_subtitles(videos, languages, min_score=0, hearing_impaired=Fal
`hearing_impaired` as keyword argument and returns the score. `hearing_impaired` as keyword argument and returns the score.
:param pool_class: class to use as provider pool. :param pool_class: class to use as provider pool.
:type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar :type pool_class: :class:`ProviderPool`, :class:`AsyncProviderPool` or similar
:param \*\*kwargs: additional parameters for the provided `pool_class` constructor. :param **kwargs: additional parameters for the provided `pool_class` constructor.
:return: downloaded subtitles per video. :return: downloaded subtitles per video.
:rtype: dict of :class:`~subliminal.video.Video` to list of :class:`~subliminal.subtitle.Subtitle` :rtype: dict of :class:`~subliminal.video.Video` to list of :class:`~subliminal.subtitle.Subtitle`