New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve validation results error description #281

Open

forsyth2 opened this issue Jul 14, 2022 · 1 comment · May be fixed by #320

Assignees

Labels

semver: small improvement

Collaborator

forsyth2 commented Jul 14, 2022

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

The text was updated successfully, but these errors were encountered:

forsyth2 self-assigned this

forsyth2 added the semver: small improvement label

This was referenced Oct 5, 2022

Configuration file validation not working #319

Open

Improve validation error #320

Draft

forsyth2 mentioned this issue

Merged

forsyth2 mentioned this issue

Validator does not provide useful feedback #47

Closed

Collaborator Author

forsyth2 commented Dec 6, 2022

#319 means that the validator doesn't appear to be working at all, thus blocking this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment