Documentation updates: New hist time handling#3837
Open
slevis-lmwg wants to merge 4 commits intoESCOMP:b4b-devfrom
Open
Documentation updates: New hist time handling#3837slevis-lmwg wants to merge 4 commits intoESCOMP:b4b-devfrom
slevis-lmwg wants to merge 4 commits intoESCOMP:b4b-devfrom
Conversation
Purpose: To update doc/source/users_guide/overview/introduction.rst with WhatsNewInCTSM5.4.md in its permanent location
slevis-lmwg
added
documentation
slevis-lmwg
added this to
CTSM: Upcoming tags, CLM documentation and LMWG: Sprint Planning Board
github-project-automation
bot
moved this to Ready to start (or start again)
in CTSM: Upcoming tags
slevis-lmwg
moved this from Ready to start (or start again)
to In progress - b4b-dev
in CTSM: Upcoming tags
slevis-lmwg
commented
Mar 24, 2026
Contributor
Author
There was a problem hiding this comment.
To clarify what I did here, starting from the original location of the WhatsNewInCTSM5.4.md file:
git mv WhatsNewInCTSM5.4.md doc/.
cd ..
ln -s doc/WhatsNewInCTSM5.4.md .
git add WhatsNewInCTSM5.4.md
git commit
...and this was the first commit of this PR: 85c7be2
Contributor
Author
There was a problem hiding this comment.
To clarify why:
- I wanted all WhatsNew files in their final locations before adding links to them
- The WhatsNew files discuss the new history time handling in greater detail that I find necessary for the User's Guide and Technote
Contributor
Author
|
For the review, I will ask Erik, Sam R., and Will, and you can decide who's most interested :-) |
8 tasks
samsrabin
added
the
next
Member
|
Added "next" to discuss reviewer assignment. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes
In the same doc locations where I had previously mentioned the h0a/h0i distinction, I now include explanations of the new time handling; namely, mid-point of time bounds for h0a and time step for h0i.
I also updated the What Is New section to include links to all WhatsNew files. This was necessary regardless, and it simultaneously addresses the need to mention the elimination of the 0th time step in our simulations. I consider the latter a subtle enough change with no tangible effect on users that we should not need separate mention in the User's Guide or Technote.
Specific notes
Contributors other than yourself, if any:
CTSM Issues Fixed (include github issue #):
Fixes #3171
Are answers expected to change (and if so in what way)?
No
Any User Interface Changes (namelist or namelist defaults changes)?
No