danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[DOCS] Fix url + multi_url docs (#635)

Browse source
This commit is contained in:
Jesse Bannon 2023-06-17 13:45:22 -07:00 committed by GitHub
parent 0f39b38dc3
commit 134882a17d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/ytdl_sub/downloaders/url/validators.py
View file

@ -75,9 +75,7 @@ class UrlValidator(StrictDictValidator):
@property @property
def url(self) -> OverridesStringFormatterValidator: def url(self) -> OverridesStringFormatterValidator:
""" """
Required. URL to download from, listed in priority from lowest (top) to highest (bottom). Required. URL to download from.
If a download exists in more than one URL, it will resolve to the bottom-most one and
inherit those variables.
""" """
return self._url return self._url
@ -199,6 +197,10 @@ class MultiUrlValidator(OptionsValidator):
def urls(self) -> UrlListValidator: def urls(self) -> UrlListValidator:
""" """
Required. A list of :ref:`url` with the addition of the ``variables`` attribute. Required. A list of :ref:`url` with the addition of the ``variables`` attribute.
Multiple URLs should be listed in the order of priority, with the lowest priority being the
top-most, and highest priority being the bottom-most. If a download exists in more than
one URL, it will resolve to the bottom-most one (the highest priority) and
inherit those variables.
""" """
return self._urls return self._urls