Document MOM_regridding and coord variable units #561
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## dev/gfdl #561 +/- ##
============================================
+ Coverage 37.20% 37.26% +0.05%
============================================
Files 271 270 -1
Lines 80440 79583 -857
Branches 14999 14789 -210
============================================
- Hits 29930 29655 -275
+ Misses 44944 44439 -505
+ Partials 5566 5489 -77 ☔ View full report in Codecov by Sentry. |
Added or amended comments describing about 90 variables in the MOM_regridding, coord_adapt, coord_rho, and coord_sigma modules to document the purpose and units of real variables using the MOM6 standard syntax. A missing doxygen comment was also added to describe inflate_vanished_layers_old(). A few unused internal variables were also eliminated, including the max_depth_index_scale element of the regridding_CS type. All answers are bitwise identical and only comments are changed.
Hallberg-NOAA
force-pushed
the
document_coord_code
branch
from
ca5be95 to
40c370e
Compare
marshallward
approved these changes
Feb 9, 2024
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/22278 ✔️ |
This was referenced May 16, 2024
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.
Added or amended comments describing about 90 variables in the MOM_regridding, coord_adapt, coord_rho, and coord_sigma modules to document the purpose and units of real variables using the MOM6 standard syntax. A missing doxygen comment was also added to describe
inflate_vanished_layers_old(). A few unused internal variables were also eliminated, including themax_depth_index_scaleelement of theregridding_CStype. All answers are bitwise identical and only comments are changed.