Skip to content

Fix typos and errors in tech note documentation - #3818

Merged
slevis-lmwg merged 6 commits into
ESCOMP:b4b-devfrom
huiqi-wang:fix-doc-underscore-typos
Mar 18, 2026
Merged

slevis-lmwg merged 6 commits into
ESCOMP:b4b-devfrom
huiqi-wang:fix-doc-underscore-typos

Conversation

@huiqi-wang

@huiqi-wang huiqi-wang commented Mar 18, 2026 •

Copy link
Copy Markdown
Contributor

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).

@huiqi-wang huiqi-wang changed the title Fix spurious underscore characters in CN_Allocation equations Fix typos and errors in tech note documentation Mar 18, 2026
@slevis-lmwg slevis-lmwg added documentation additions or edits to user-facing documentation or its infrastructure b4b bit-for-bit docs-loc:tech-note Relates to Technical Note (science) labels Mar 18, 2026
@slevis-lmwg slevis-lmwg moved this to In Progress in CLM documentation Mar 18, 2026

@slevis-lmwg slevis-lmwg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :-)

@slevis-lmwg
slevis-lmwg changed the base branch from master to b4b-dev March 18, 2026 19:16
@slevis-lmwg

Copy link
Copy Markdown
Contributor

@huiqi-wang I'm reposting your note from above to create an issue from it:

There is a missing equation reference in line 168 of CN_Allocation/CLM50_Tech_Note_CN_Allocation.rst ("from Eq., as") that > needs the correct equation number filled in. Similar empty references exist in Lake/CLM50_Tech_Note_Lake.rst.

@slevis-lmwg

Copy link
Copy Markdown
Contributor

@huiqi-wang before I merge this to b4b-dev, I wanted to confirm whether you planned any other updates. Thanks!

@huiqi-wang

Copy link
Copy Markdown
Contributor Author

@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?

@slevis-lmwg

Copy link
Copy Markdown
Contributor

Separate PRs will be great, thank you!

@slevis-lmwg
slevis-lmwg merged commit 362fece into ESCOMP:b4b-dev Mar 18, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in CLM documentation Mar 18, 2026
@slevis-lmwg slevis-lmwg mentioned this pull request Mar 27, 2026
6 tasks done
@slevis-lmwg slevis-lmwg mentioned this pull request May 21, 2026
7 of 25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit docs-loc:tech-note Relates to Technical Note (science) documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants