From d8667a9fb668fcd0c439f0beea37f29215b19bae Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Mon, 1 Apr 2024 02:56:56 -0700 Subject: [PATCH] docgen --- .../config_reference/scripting/entry_variables.rst | 12 ++++++++++++ .../scripting/scripting_functions.rst | 7 +++++++ .../config_reference/scripting/static_variables.rst | 5 +++++ 3 files changed, 24 insertions(+) diff --git a/docs/source/config_reference/scripting/entry_variables.rst b/docs/source/config_reference/scripting/entry_variables.rst index 8aa85ca6..84247234 100644 --- a/docs/source/config_reference/scripting/entry_variables.rst +++ b/docs/source/config_reference/scripting/entry_variables.rst @@ -647,3 +647,15 @@ ytdl_sub_input_url :type: ``String`` :description: The input URL used in ytdl-sub to create this entry. + +ytdl_sub_input_url_count +~~~~~~~~~~~~~~~~~~~~~~~~ +:type: ``Integer`` +:description: + The total number of input URLs as defined in the subscription. + +ytdl_sub_input_url_index +~~~~~~~~~~~~~~~~~~~~~~~~ +:type: ``Integer`` +:description: + The index of the input URL as defined in the subscription, top-most being the 0th index. diff --git a/docs/source/config_reference/scripting/scripting_functions.rst b/docs/source/config_reference/scripting/scripting_functions.rst index db773b17..e213b7b8 100644 --- a/docs/source/config_reference/scripting/scripting_functions.rst +++ b/docs/source/config_reference/scripting/scripting_functions.rst @@ -655,6 +655,13 @@ upper Ytdl-Sub Functions ------------------ +is_bilateral_playlist_url +~~~~~~~~~~~~~~~~~~~~~~~~~ +:spec: ``is_bilateral_playlist_url(url: String) -> Boolean`` + +Heuristic that returns True if the URL is known to be bilateral, meaning that entries can +be added to the beginning or end. + legacy_bracket_safety ~~~~~~~~~~~~~~~~~~~~~ :spec: ``legacy_bracket_safety(value: ReturnableArgument) -> ReturnableArgument`` diff --git a/docs/source/config_reference/scripting/static_variables.rst b/docs/source/config_reference/scripting/static_variables.rst index e6e41527..2825edba 100644 --- a/docs/source/config_reference/scripting/static_variables.rst +++ b/docs/source/config_reference/scripting/static_variables.rst @@ -5,6 +5,11 @@ Static Variables Subscription Variables ---------------------- +subscription_has_download_archive +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Returns True if the subscription has any entries recorded in a download archive. False +otherwise. + subscription_indent_i ~~~~~~~~~~~~~~~~~~~~~ For subscriptions in the form of