ESCOMP / ESCOMP/CTSM

Tech Note: Add "out of date" disclaimer to parameter tables

Open
#3,951 1 comment 0 reactions 1 assignee Claimed by @samsrabin View on GitHub
b4b docs-loc:tech-note docs:minor-content-fix documentation
Dominant language
Fortran
Stars
352
Forks
361
Avg merge
2d 21h
Merged PRs (30d)
7

Description

### What sort(s) of documentation issue is this?
- [ ] Something is missing.
- [ ] Something is (or might be) incorrect or outdated.
- [x] Something is confusing.
- [ ] Something is broken.

### What part(s) of the documentation does this concern?
- [x] [Technical Note](https://escomp.github.io/CTSM/tech_note/index.html) (science and design of the model)
- [ ] [User's Guide](https://escomp.github.io/CTSM/users_guide/index.html) (using the model and related tools)
- [ ] Somewhere else (e.g., README file, tool help text, or code comment): _Please specify_
- [ ] I don't know

### Describe the issue
As described in #3923, there are a bunch of tables in the Tech Note that are just values from the parameter file. It would be nice to keep those up-to-date as that issue says, but in the meantime, we should add a disclaimer to the captions of all such tables saying that they may be out-of-date.

### Additional context (optional)
- Could be out-of-date with the CTSM version corresponding to the docs you're looking at, BUT ALSO could be out-of-date relative to the version you're working with.
- Link to the ["Tools for working with parameter files" docs](https://escomp.github.io/CTSM/users_guide/using-clm-tools/paramfile-tools.html): `query_paramfile` can be used to get values.
- Do this using a Sphinx substitution so we don't have to repeat ourselves.

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.