Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/bmauer/markup docs in source #2311

Merged
merged 18 commits into from
Aug 24, 2023

Conversation

bena-nasa
Copy link
Collaborator

@bena-nasa bena-nasa commented Aug 21, 2023

@JulesKouatchou @tclune
This PR brings the markdown files I added to develop. It should be obvious from looking at the details of the files changed in the PR what was added. Note that one of the markdown files (the one for PFIO) referenced some pictures to illustrated how the server worked. I had to add the PNG files to the directory with the markdown file so it would still display the pictures.

It looks like I added a .md file for
ExtData2g
History
PFIO
Arithmetic Parser
Error Handling Macros
Regridding Methods
ExtDataDriver.x
Regrid_Util.x
CapGridComp

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Trivial change (affects only documentation or cleanup)

Checklist:

  • I have tested this change with a run of GEOSgcm (if non-trivial)
  • I have added one of the required labels (0 diff, 0 diff trivial, 0 diff structural, non 0-diff)
  • I have updated the CHANGELOG.md accordingly following the style of Keep a Changelog

@bena-nasa bena-nasa added 📝 Documentation Improvements or additions to documentation 0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.) 0 Diff The changes in this pull request have verified to be zero-diff with the target branch. labels Aug 21, 2023
@bena-nasa bena-nasa requested a review from a team as a code owner August 21, 2023 15:34
tclune
tclune previously approved these changes Aug 21, 2023
@bena-nasa
Copy link
Collaborator Author

@JulesKouatchou I added a wiki page about MAPL CapGridComp and added a markdown file with the same contents to this branch

@mathomp4 mathomp4 self-requested a review August 24, 2023 17:00
@mathomp4 mathomp4 merged commit 614dcb2 into develop Aug 24, 2023
10 checks passed
@mathomp4 mathomp4 deleted the feature/bmauer/markup_docs_in_source branch August 24, 2023 17:00
@bena-nasa bena-nasa requested a review from tclune August 24, 2023 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 Diff Trivial The changes in this pull request are trivially zero-diff (documentation, build failure, &c.) 0 Diff The changes in this pull request have verified to be zero-diff with the target branch. 📝 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants