Fix RTD, minor updates to documentation #437
Merged
Conversation
This file contains 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
- Minor update to icepack_mushy_physics inline documentation - Update Icepack interfaces documentation, add icepack_mushy public interfaces - Remove trailing blank spaces in source code
icepack_kinds is used by all files in columnphysics, so should be comprehensive.
dabail10
approved these changes
May 15, 2023
eclare108213
approved these changes
May 19, 2023
| @@ -1,3 +1,6 @@ | |||
| #ifdef CCSMCOUPLED | |||
| #define CESMCOUPLED | |||
| #endif | |||
There was a problem hiding this comment.
awesome solution, thank you
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR checklist
Short (1 sentence) summary of your PR:
Fix Readthdocs after recent changes, update documentation
Developer(s):
apcraig
Suggest PR reviewers from list in the column to the right.
Please copy the PR test results link or provide a summary of testing completed below.
All bit-for-bit in full icepack test suite, https://github.com/CICE-Consortium/Test-Results/wiki/icepack_by_hash_forks#f36fccbddd20ef64bb95282dd85db726dbaa1f76. PGI tests did not complete due to login timeout, should be OK. CCSMCOUPLED cpp still needs testing in coupled system.
How much do the PR code changes differ from the unmodified code?
Does this PR create or have dependencies on CICE or any other models?
Does this PR add any new test cases?
Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
Please provide any additional information or relevant details below:
Update readthedocs implementation consistent with @dabail10 implementation in Add functionality to change hist_avg for each stream CICE#827.
Update icepack interface documentation and add new public mushy subroutines (should have been done before).
Remove trailing spaces in source code.
Add cpp CCSMCOUPLED equivalent to CESMCOUPLED via icepack_kinds.