-
Notifications
You must be signed in to change notification settings - Fork 416
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
Improve advection docstring #3093
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution! Just a couple minor tweaks and (provided Sphinx is happy) this is good to go!
Would you be wiling to add a Notes section with the equation for advection, similar to what's in MetPy/src/metpy/calc/kinematics.py Lines 75 to 88 in ae58134
? |
Co-authored-by: Ryan May <rmay31@gmail.com>
Co-authored-by: Ryan May <rmay31@gmail.com>
Yes, I added an equation to the Notes section. Now that the PR passes all the tests, it should be good to go in. |
Co-authored-by: jthielen <jt@thielen.science>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
Description Of Changes
Improves the documentation of
mpcalc.advection
.Checklist