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

[0.25deg config] Manually add auto-generated MOM_parameter_doc.* for comprehensive documentation #174

Open
minghangli-uni opened this issue Jun 19, 2024 · 0 comments
Assignees

Comments

@minghangli-uni
Copy link
Contributor

As proposed in #117, MOM_parameter_doc.all along with MOM_parameter_doc.layout and MOM_parameter_doc.debugging provides comprehensive documentation for all parameters. As suggested by @aekiss, it is useful to update these three log files (specific for MOM_parameter_doc.all ) along with MOM_input for the parameter changes.

For this to be useful rather than misleading, MOM_parameter_doc.* would need to be kept in sync with MOM_input

Please note that there is an existing bug: MOM_parameter_doc.all does not include all used parameters.

NB: a CI workflow to update these MOM_parameter_doc.* will be addressed soon. For now, I am manually adding it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants