Skip to content
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.

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

Change wording about schema-validation errors #680

Merged

Conversation

maddenp-noaa
Copy link
Collaborator

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 using uwtools.api.config.validate() to do schema validation of that tool's config file. On a faulty config, the output currently looks like

[2024-12-18T19:53:21]    ERROR 4 UW schema-validation errors found in config
...

It's the UW part that's confusing: A user of this tool wouldn't have any idea what UW means, and the schema doesn't belong to uwtools anyway. I think I added the UW part to this message to differentiate it from errors arising from validation of Rocoto XML schemas, so the messages mention UW and Rocoto respectively. I think keeping Rocoto in place will keep the difference clear, but removing UW will make the validate() function more useful in external applications.

Type

  • Bug fix (corrects a known issue)

Impact

  • This is a non-breaking change (existing functionality continues to work as expected)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.

@maddenp-noaa maddenp-noaa merged commit 71f5847 into ufs-community:main Dec 19, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the schema-error-wording-fix branch December 19, 2024 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants