update hydrology documentation#3954
Conversation
|
@YifanCheng Could you please fill out the PR template? Make sure to also include a brief description of what you changed. Thanks! |
|
@YifanCheng is this just a test case of the documentation workflow, an in progress workflow, or ready for review? |
|
@samsrabin @wwieder Sorry, this is solely a practice PR during the second session! Not ready for merging yet! Should I delete it? Or should I leave it here, and later on, I can merge new commits to this PR? Whichever works for me. Please let me know. |
|
If the changes you made are ones you intend to keep, please (1) change the title to remove "experiment" and (2) mark it as a draft so we know it's not ready to be reviewed. If you don't intend to keep these changes, then go ahead and delete. Thanks! |
samsrabin
left a comment
There was a problem hiding this comment.
Thanks for this, @YifanCheng! Looks mostly good; I just have one request.
|
|
||
| .. math:: | ||
| :label: 1.104 | ||
| :label: 7.89b |
There was a problem hiding this comment.
Since you're already relabeling equations (here and elsewhere in this file), would you mind changing them to something meaningful as mentioned in the style guide?
There was a problem hiding this comment.
Hi Sam,
Thank you for catching this and demonstrating how the labeling should be done! I updated the label for this equation, as well as one for calculating W_can. Please let me know if additional edits are required.
Yifan
Description of changes
Update the hydrology section documentation.
The following major changes have been made:
Others are minor formatting or typo issues identified in the documentation.
Specific notes
Contributors other than yourself, if any: None
CTSM Issues Fixed (include github issue #): #3853 (comment)
Are answers expected to change (and if so in what way)?
No
Any User Interface Changes (namelist or namelist defaults changes)?
No
Does this create a need to change or add documentation? Did you do so?
Only documentation in the hydrology section gets updated based on existing code changes.
Testing performed, if any:
(List what testing you did to show your changes worked as expected)
(This can be manual testing or running of the different test suites)
(Documentation on system testing is here: https://github.com/ESCOMP/ctsm/wiki/System-Testing-Guide)
(aux_clm on derecho for intel/gnu and izumi for intel/gnu/nag/nvhpc is the standard for tags on master)
NOTE: Be sure to check your coding style against the standard
(https://github.com/ESCOMP/ctsm/wiki/CTSM-coding-guidelines) and review
the list of common problems to watch out for
(https://github.com/ESCOMP/CTSM/wiki/List-of-common-problems).
If this PR changes the CTSM web documentation, please see our contribution guidelines for documentation.