E3SM-Project / E3SM-Project/zppy

Improve validation results error description

Open
#281 1 comment 0 reactions 1 assignee Claimed by @forsyth2 View on GitHub
semver: small improvement
Dominant language
Python
Stars
8
Forks
16
Avg merge
3d 21h
Merged PRs (30d)
3

Description

Currently, a validation results error produces output in a hard-to-understand dictionary: https://github.com/E3SM-Project/zppy/blob/main/zppy/__main__.py#L171

Suggestions for improving the error description:
- Pretty print the dictionary
- Print only the keys/values with `False` in the validation dictionary
- Print a link to the tutorial, which has examples of how values should look (but not for all parameters...)
- See if there's any way for the `Validator` to give more information on why it failed

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.