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

Add comments and doc changes from walkthrough sessions #368

Merged
merged 12 commits into from
Oct 28, 2022

Conversation

mcgibbon
Copy link
Collaborator

@mcgibbon mcgibbon commented Oct 27, 2022

Purpose

Over the past two months we've held fv3core walkthrough sessions with Lucas and others from GFDL. This PR adds the comments and documentation changes we wrote during those sessions to the dynamical core, including many TODOs.

Code changes:

  • Renamed some internal functions and variables, updated docstrings and added comments in pace.fv3core

Checklist

Before submitting this PR, please make sure:

  • You have followed the coding standards guidelines established at Code Review Checklist.
  • Docstrings and type hints are added to new and updated routines, as appropriate
  • All relevant documentation has been updated or added (e.g. README, CONTRIBUTING docs)
  • For each public change and fix in pace-util, HISTORY has been updated
  • Unit tests are added or updated for non-stencil code changes

@mcgibbon mcgibbon changed the title Add comments and documentation changes from walkthrough sessions Add comments and doc changes from walkthrough sessions Oct 27, 2022
@mcgibbon mcgibbon requested a review from elynnwu October 27, 2022 19:10
@mcgibbon mcgibbon marked this pull request as ready for review October 27, 2022 19:10
@elynnwu
Copy link
Collaborator

elynnwu commented Oct 28, 2022

launch jenkins

@mcgibbon mcgibbon merged commit 3435a48 into main Oct 28, 2022
@mcgibbon mcgibbon deleted the feature/fv3core_walkthrough branch October 28, 2022 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants