only show first error

Author: hamelsmu

quartodoc/autosummary.py

@@ -451,8 +451,10 @@ def load_layout(self, sections: dict, package: str):
         try:
             return layout.Layout(sections=sections, package=package)
         except ValidationError as e:
-            msg = 'Configuration error(s) for YAML:\n - '
-            msg += '\n - '.join([fmt(err) for err in e.errors() if fmt(err)])           
+            msg = 'Configuration error for YAML:\n - '
+            errors = [fmt(err) for err in e.errors() if fmt(err)]
+            first_error = errors[0] # we only want to show one error at a time b/c it is confusing otherwise
+            msg += first_error           
             raise ValueError(msg) from None
 
     # building ----------------------------------------------------------------

quartodoc/tests/test_validation.py

@@ -46,7 +46,6 @@
 def test_valid_yaml():
     Builder(sections=EXAMPLE_SECTIONS, package='quartodoc')
 
-
 def test_missing_title():
     sections = copy.deepcopy(EXAMPLE_SECTIONS)
     del sections[0]['title']
@@ -64,8 +63,16 @@ def test_missing_desc():
 
     assert '- Missing field `desc` for element 2 in the list for `sections`' in str(e.value)
 
-def test_missing_name_contents():
-    # This is failing on purpose, will fix in pair programming
+def test_missing_name_contents_1():
     sections = copy.deepcopy(EXAMPLE_SECTIONS)
     del sections[2]['contents'][0]['name']
-    Builder(sections=sections, package='quartodoc')
+    with pytest.raises(ValueError) as e:
+        Builder(sections=sections, package='quartodoc')
+    assert '- Missing field `name` for element 0 in the list for `contents` located in element 2 in the list for `sections`' in str(e.value)
+
+def test_missing_name_contents_2():
+    sections = copy.deepcopy(EXAMPLE_SECTIONS)
+    del sections[1]['contents'][0]['name']
+    with pytest.raises(ValueError) as e:
+        Builder(sections=sections, package='quartodoc')
+    assert '- Missing field `name` for element 0 in the list for `contents` located in element 1 in the list for `sections`' in str(e.value)

quartodoc/validation.py

@@ -14,7 +14,10 @@ def fmt(err:dict):
             msg += f" from root level: `{err['loc'][0]}`"
         elif len(err['loc']) == 3:
             msg += f" `{err['loc'][2]}` for element {err['loc'][1]} in the list for `{err['loc'][0]}`"
-                
+        elif len(err['loc']) == 5:
+            msg += f" `{err['loc'][4]}` for element {err['loc'][3]} in the list for `{err['loc'][2]}` located in element {err['loc'][1]} in the list for `{err['loc'][0]}`"
+        elif len(err['loc']) == 6 and err['loc'][4] == 'Auto':
+            msg += f" `{err['loc'][5]}` for element {err['loc'][3]} in the list for `{err['loc'][2]}` located in element {err['loc'][1]} in the list for `{err['loc'][0]}`"
     else:
-        msg += str(err['msg'])
+        msg += str(err)
     return msg