Change wording about schema-validation errors #680
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Synopsis
A simple wording change in a log message, with a lot of updates in docs, notebooks, and tests.
I am using
uwtools
as a package in the ML verification tool I'm working on, and at the moment am usinguwtools.api.config.validate()
to do schema validation of that tool's config file. On a faulty config, the output currently looks likeIt's the
UW
part that's confusing: A user of this tool wouldn't have any idea whatUW
means, and the schema doesn't belong touwtools
anyway. I think I added theUW
part to this message to differentiate it from errors arising from validation of Rocoto XML schemas, so the messages mentionUW
andRocoto
respectively. I think keepingRocoto
in place will keep the difference clear, but removingUW
will make thevalidate()
function more useful in external applications.Type
Impact
Checklist