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

Refine error and warning messages when configuration options are provided as the wrong data type #2735

Open
8 of 21 tasks
JohnHalleyGotway opened this issue Nov 13, 2023 · 0 comments
Assignees
Labels
alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle component: code cleanup Code cleanup and maintenance issue priority: low Low Priority requestor: NOAA/EMC NOAA Environmental Modeling Center type: enhancement Improve something that it is currently doing

Comments

@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented Nov 13, 2023

Describe the Enhancement

Discussion dtcenter/METplus#2417 referenced a warning message from MET that required further explanation. Ideally the warning/error messages MET writes would provide better guidance to users about how to fix the problem.

WARNING: Dictionary::lookup_num_array() -> numeric array lookup failed for name "GRIB2_ipdtmpl_val"

The issue is that the code expected an array of numbers but the setting was defined as a string. As discussed at the NOAA METplus User Telecon on 11/13/2023, recommend refining the warning message in this case to more clearly list the data type expected versus the data type provided.

WARNING: Dictionary::lookup_num_array() -> the “GRIB2_ipdtmpl_index” configuration option must be specified as a numeric type rather than a string

While this isn't a high priority issue, it's a good idea to routinely clean up and clarify debug, warning, and error messages as we encounter them. Recommend warning/error messages throughout in a similar way to indicate expected vs actual data types.

Time Estimate

1 day?

Sub-Issues

Consider breaking the enhancement down into sub-issues.
None needed.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as the next official version or Backlog of Development Ideas
  • For the next official version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Enhancement Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: MET-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added type: enhancement Improve something that it is currently doing component: code cleanup Code cleanup and maintenance issue requestor: NOAA/EMC NOAA Environmental Modeling Center priority: low Low Priority labels Nov 13, 2023
@JohnHalleyGotway JohnHalleyGotway added this to the MET 12.0.0 milestone Nov 13, 2023
@JohnHalleyGotway JohnHalleyGotway self-assigned this Nov 13, 2023
@JohnHalleyGotway JohnHalleyGotway moved this from 🔖 Ready to 📋 Backlog in MET-12.0.0 Development Nov 13, 2023
@JohnHalleyGotway JohnHalleyGotway moved this from 📋 Backlog to 🔖 Ready in MET-12.0.0 Development Nov 13, 2023
@JohnHalleyGotway JohnHalleyGotway added the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle component: code cleanup Code cleanup and maintenance issue priority: low Low Priority requestor: NOAA/EMC NOAA Environmental Modeling Center type: enhancement Improve something that it is currently doing
Projects
None yet
Development

No branches or pull requests

1 participant