DOC: Move equations to Notes in kinematics docstrings#4095
Open
manduinca wants to merge 1 commit into
Open
Conversation
|
|
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
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.
Description Of Changes
Scoped to
metpy.calc.kinematicsfor a focused first pass at #2677. Moves the equation blocks and implementation details out of the function description (aboveParameters) and into theNotessection, so they render belowParameters/Returns.Affects
frontogenesis,storm_relative_helicity,potential_vorticity_baroclinic,potential_vorticity_barotropic,inertial_advective_windandq_vector. This leaves the module consistent with the pattern already used here byvorticity,divergence,advectionandtotal_deformation.potential_vorticity_barotropicandq_vectorhad noNotessection, so I added one and moved the stray.. versionchanged::into it. Docstrings only — no code, signatures or behaviour changed, and the doctests are untouched. Happy to follow up with the remaining modules (thermo, indices, …) in separate PRs.Checklist