check_undocumented_public_models

This check identifies any public models that do not include documentation on all of the models defined columns, as well as the model itself. It is a stricter version of the check_model_descriptions because it also looks at column descriptions.

Version History

Added in Debby v0.3.0

Parameters

This check does not support any custom parameters.

Info

For more information about how to set custom parameters for a check, see the documentation on configuration.

Source

def check(model: dict):
    if model["access"] == "public":
        for column in model["columns"].values():
            assert column["description"] not in ("", None)