Repository navigation
Fix typos and errors in tech note documentation - #3818
Conversation
slevis-lmwg
left a comment
There was a problem hiding this comment.
Thank you for these corrections, @huiqi-wang. In one case, I could not discern your updates, so I asked gemini to point them out to me :-)
|
@huiqi-wang I'm reposting your note from above to create an issue from it:
|
|
@huiqi-wang before I merge this to b4b-dev, I wanted to confirm whether you planned any other updates. Thanks! |
Hi @slevis-lmwg, thanks! I will be working on other sections of the doc for correcting potential errors, maybe i can just submit another pull request that time or you prefer me to do them all in this PR? |
|
Separate PRs will be great, thank you! |
Description of changes
Specific notes
Contributors other than yourself, if any:
CTSM Issues Fixed (include github issue #):
Removed 30 spurious _ characters and fix typos
Are answers expected to change (and if so in what way)?
Any User Interface Changes (namelist or namelist defaults changes)?
Does this create a need to change or add documentation? Did you do so?
Yes
Note: There is also a missing equation reference on line 168 of CN_Allocation/CLM50_Tech_Note_CN_Allocation.rst ("from Eq., as") that may need the correct equation number filled in? Similar empty references exist in Lake/CLM50_Tech_Note_Lake.rst too. I am not sure if this would be an issue, as there are just many of them.
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).