add docstring to test_dict_subclass_error function

omry · May 11, 2021 · b58bcd5 · b58bcd5
1 parent 11c210e
commit b58bcd5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/tests/test_errors.py b/tests/test_errors.py
@@ -1436,6 +1436,12 @@ def test_get_full_key_failure_in_format_and_raise() -> None:
 
 
 def test_dict_subclass_error() -> None:
+    """
+    Test calling OmegaConf.structured(malformed_dict_subclass).
+    We expect a ValueError and a UserWarning (deprecation) to be raised simultaneously.
+    We are using a separate function instead of adding
+    warning support to the giant `test_errors` function above,
+    """
     src = Str2Int()
     src["bar"] = "qux"  # type: ignore
     # expected.finalize(cfg)