add more tests and cases

Author: hamelsmu

quartodoc/tests/test_validation.py

@@ -74,3 +74,10 @@ def test_missing_name_contents_2():
     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)
+
+def test_misplaced_kindpage():
+    sections = copy.deepcopy(EXAMPLE_SECTIONS)
+    sections[0]['kind'] = 'page'
+    with pytest.raises(ValueError) as e:
+        Builder(sections=sections, package='quartodoc')
+    assert ' - Missing field `path` for element 0 in the list for `sections`, which you need when setting `kind: page`.' in str(e.value)

quartodoc/validation.py

@@ -14,10 +14,17 @@ 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']) == 4 and err['loc'][2] == 'Page':
+            msg += f" `{err['loc'][3]}` for element {err['loc'][1]} in the list for `{err['loc'][0]}`, which you need when setting `kind: page`."
         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:
+            return str(err) # so we can debug and include more cases
     else:
         msg += str(err)
     return msg
+
+
+# {'loc': ('sections', 0, 'Page', 'path'), 'msg': 'field required', 'type': 'value_error.missing'} ... }