Fix some formatting in MPAS-Ocean Registry for generating docs#6293
Merged
Conversation
xylar
added
MPAS-ocean
Contributor
Author
|
Discussion on this PR can be seen at: E3SM-Ocean-Discussion#81 |
mark-petersen
approved these changes
Mar 14, 2024
Contributor
mark-petersen
left a comment
mark-petersen
left a comment
There was a problem hiding this comment.
Yes, this is all correct. Thanks!
xylar
commented
Mar 20, 2024
jonbob
reviewed
Mar 20, 2024
| <entry id="config_sw_absorption_type" type="char*1024" | ||
| category="shortwaveRadiation" group="shortwaveRadiation"> | ||
| Name of shortwave absorption type used in simulation. | ||
| Name of shortwave absorption type used in simulation. |
Contributor
There was a problem hiding this comment.
This may have to be fixed in Registry instead of by hand in this generated file
Contributor
Author
There was a problem hiding this comment.
I fixed this in the registry as well.
Contributor
Author
There was a problem hiding this comment.
I use an editor that automatically trims trailing whitespace (which I wish more folks would do). It seems easier to fix this than to revert it.
Contributor
There was a problem hiding this comment.
No need to revert it if you fixed it in Registry as well. Thanks for taking that on
Contributor
To generate Latex documentation from the Registry, we need to escape Latex in the namelist and variable descriptions.
xylar
force-pushed
the
ocn/fix-registry-for-docs
branch
from
69be54d to
271b548
Compare
jonbob
added a commit
that referenced
this pull request
Mar 27, 2024
Fix some formatting in MPAS-Ocean Registry for generating docs To generate Latex documentation from the Registry, we need to escape Latex in the namelist and variable descriptions. [BFB]
Contributor
|
@xylar -- thanks for having the bld files completely consistent with Registry. Passes sanity testing with:
merged to next |
Contributor
|
merged to master |
Contributor
Author
|
@jonbob, thanks so much! |
xylar
added a commit
to xylar/compass
that referenced
this pull request
May 8, 2024
This merge updates the E3SM-Project submodule from [93e511d](https://github.com/E3SM-Project/E3SM/tree/93e511d) to [31e0924](https://github.com/E3SM-Project/E3SM/tree/31e0924). This update includes the following MPAS-Ocean and MPAS-Frameworks PRs (check mark indicates bit-for-bit with previous PR in the list): - [ ] (ocn) E3SM-Project/E3SM#6256 - [ ] (ocn) E3SM-Project/E3SM#6224 - [ ] (ocn) E3SM-Project/E3SM#6270 - [ ] (ocn) E3SM-Project/E3SM#6293 - [ ] (ocn) E3SM-Project/E3SM#6321 - [ ] (ocn) E3SM-Project/E3SM#6262 - [ ] (ocn) E3SM-Project/E3SM#6300 - [ ] (ocn) E3SM-Project/E3SM#6334 - [ ] (ocn) E3SM-Project/E3SM#6371 - [ ] (ocn) E3SM-Project/E3SM#6288
11 tasks
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
3 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.
To generate Latex documentation from the Registry, we need to escape Latex in the namelist and variable descriptions.