smeds / mkdocs_yaml_schema_plugin Goto Github PK

Currently a description for every second-level item is implicitly required, and not having one will result in a KeyError:

I guess it is reasonable to require a description to encourage better documentation, but it would probably be better if this was done explicitly. My suggestion is to either catch the exception and re-raise it with a better message to indicate what file and item is failing, or simply default to an empty description.

The same applies to the item type; should be there, but should probably be made explicit.

I'd be happy to submit a PR if we can decide on what solution would be best.

Antingen ge tillbaka tom tabell eller vettigt felmeddelande