Refine error and warning messages when configuration options are provided as the wrong data type #2735
Open
8 of 21 tasks
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
Milestone
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.
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.
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
Labels
Milestone and Projects
Define Related Issue(s)
Consider the impact to the other METplus components.
No impacts.
Enhancement Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
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
The text was updated successfully, but these errors were encountered: