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

fix docs

Browse source
This commit is contained in:
Jesse Bannon 2023-12-17 00:42:15 -08:00
parent 165e454eef
commit 5030a34c49
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/config.rst
View file

@ -95,7 +95,7 @@ ytdl_options
overrides
"""""""""
.. autoclass:: ytdl_sub.config.preset_options.Overrides()
.. autoclass:: ytdl_sub.config.overrides.Overrides()
.. _parent preset:
@ -423,7 +423,7 @@ Traditional subscriptions that can override presets will still work when using `
Source Variables
----------------
.. autoclass:: ytdl_sub.entries.variables.entry_variables.EntryVariables
.. autoclass:: ytdl_sub.entries.script.variable_definitions.VariableDefinitions()
:members:
:inherited-members:
:undoc-members:

10
src/ytdl_sub/entries/script/variable_definitions.py
View file

@ -283,7 +283,7 @@ class VariableDefinitions:
Returns
-------
str
The playlist unique ID if it exists, otherwise return Variable("")
The playlist unique ID if it exists, otherwise return the entry unique ID.
"""
return MetadataVariable(variable_name="playlist_uid", metadata_key="playlist_id")
@ -446,7 +446,7 @@ class VariableDefinitions:
Returns
-------
str
The playlist uploader if it exists, otherwise return Variable("")
The playlist uploader if it exists, otherwise return the entry uploader.
"""
return MetadataVariable("playlist_uploader", metadata_key=self.uploader.metadata_key)
@ -478,7 +478,7 @@ class VariableDefinitions:
Returns
-------
str
The source uploader if it exists, otherwise return Variable("")
The source uploader if it exists, otherwise return the playlist_uploader
"""
return MetadataVariable("source_uploader", metadata_key=self.uploader.metadata_key)
@ -645,7 +645,7 @@ class VariableDefinitions:
Returns
-------
str
The entry's uploaded date, in YYYYMMDD format. If not present, return Variable("")
The entry’s uploaded date, in YYYYMMDD format. If not present, return today’s date.
"""
return MetadataVariable(variable_name="upload_date", metadata_key="upload_date")
@ -818,7 +818,7 @@ class VariableDefinitions:
Returns
-------
str
The entry's release date, in YYYYMMDD format. If not present, return Variable("")
The entry’s release date, in YYYYMMDD format. If not present, return the upload date.
"""
return MetadataVariable(variable_name="release_date", metadata_key="release_date")