E3SM-Project / E3SM-Project/EKAT

YAML utilization tool

Open
#149 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
22
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Would it be possible to generate a tool, most likely in EKAT, that could check if all valid entries in a YAML file are used, and then issue a warning to screen if any entries are ignored?

Maybe a general approach would be to store all entries in a yaml file as a map to a bool and trigger true the first time an entry is gotten with `param_list.get`?

The use case I can think of is that currently the YAML parser will ignore anything that isn't requested, and in a lot of cases we use "if" statements to check if something is in the YAML file at all before taking some action. A typo in the yaml file is enough to cause the "if" statement to be false which can make a user believe something is happening when it isn't. A warning printed to screen would be enough to alert a user to the fact that they've made a mistake in the YAML file.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.