From 3dceb9332bedec91abb8acc8653af4783c1d7b4a Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 28 Aug 2022 10:55:38 -0700 Subject: [PATCH] updated docs --- docs/config.rst | 8 ++++++++ src/ytdl_sub/plugins/date_range.py | 2 +- src/ytdl_sub/validators/string_datetime.py | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 77290024..eba07f73 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -185,6 +185,14 @@ chapters ------------------------------------------------------------------------------- +date_range +'''''''''' +.. autoclass:: ytdl_sub.plugins.date_range.DateRangeOptions() + :members: + :member-order: bysource + +------------------------------------------------------------------------------- + music_tags '''''''''' .. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions() diff --git a/src/ytdl_sub/plugins/date_range.py b/src/ytdl_sub/plugins/date_range.py index 8859cc26..15b592e0 100644 --- a/src/ytdl_sub/plugins/date_range.py +++ b/src/ytdl_sub/plugins/date_range.py @@ -10,7 +10,7 @@ from ytdl_sub.validators.string_datetime import StringDatetimeValidator class DateRangeOptions(PluginOptions): """ - Only download media within the specified date range + Only download files uploaded within the specified date range. Usage: diff --git a/src/ytdl_sub/validators/string_datetime.py b/src/ytdl_sub/validators/string_datetime.py index 5b1c43f0..69f6bb95 100644 --- a/src/ytdl_sub/validators/string_datetime.py +++ b/src/ytdl_sub/validators/string_datetime.py @@ -14,7 +14,7 @@ class StringDatetimeValidator(OverridesStringFormatterValidator): A string in the format YYYYMMDD or (now|today|yesterday|date)[+-][0-9](microsecond|second|minute|hour|day|week|month|year)(s) - Valid examples are ``now-2weeks`` or ``20200101``. + Valid examples are ``now-2weeks`` or ``20200101``. Can use override variables in this. """ _expected_value_type_name = "datetime string"