From 9b90c367a56180364372ff74a9987f73720bd321 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Mon, 20 Feb 2023 10:57:40 -0800 Subject: [PATCH] [DOCS] Better error message for strict override variable fields (#452) * [DOCS] Better error message for strict override variable fields * fix unit test --- src/ytdl_sub/validators/string_formatter_validators.py | 5 +++-- tests/unit/validators/test_string_formatter_validator.py | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/ytdl_sub/validators/string_formatter_validators.py b/src/ytdl_sub/validators/string_formatter_validators.py index eb422c00..ef4d272e 100644 --- a/src/ytdl_sub/validators/string_formatter_validators.py +++ b/src/ytdl_sub/validators/string_formatter_validators.py @@ -213,8 +213,9 @@ class OverridesStringFormatterValidator(StringFormatterValidator): """ _variable_not_found_error_msg_formatter = ( - "Override variable '{variable_name}' does not exist. " - "Available override variables: {available_fields}" + "Override variable '{variable_name}' does not exist. For this field, ensure your override " + "variable does not contain any source variables - it is a requirement that this be a " + "static string. Available override variables: {available_fields}" ) diff --git a/tests/unit/validators/test_string_formatter_validator.py b/tests/unit/validators/test_string_formatter_validator.py index 9481ec2a..f0140de4 100644 --- a/tests/unit/validators/test_string_formatter_validator.py +++ b/tests/unit/validators/test_string_formatter_validator.py @@ -110,6 +110,8 @@ class TestStringFormatterValidator(object): if string_formatter_class == OverridesStringFormatterValidator: expected_error_msg = ( f"Validation error in test: Override variable 'bah_humbug' does not exist. " + f"For this field, ensure your override variable does not contain any source " + f"variables - it is a requirement that this be a static string. " f"Available override variables: {', '.join(sorted(variable_dict.keys()))}" )