From 5030a34c499be3d8daebb7566971056d418d6e95 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 17 Dec 2023 00:42:15 -0800 Subject: [PATCH] fix docs --- docs/config.rst | 4 ++-- src/ytdl_sub/entries/script/variable_definitions.py | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index b1f05b7f..d70b0e88 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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: diff --git a/src/ytdl_sub/entries/script/variable_definitions.py b/src/ytdl_sub/entries/script/variable_definitions.py index a57b83ef..6c576db4 100644 --- a/src/ytdl_sub/entries/script/variable_definitions.py +++ b/src/ytdl_sub/entries/script/variable_definitions.py @@ -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")