Skip to content

DOC: Move equations to Notes in kinematics docstrings#4095

Open
manduinca wants to merge 1 commit into
Unidata:mainfrom
manduinca:docs/kinematics-equations-to-notes
Open

DOC: Move equations to Notes in kinematics docstrings#4095
manduinca wants to merge 1 commit into
Unidata:mainfrom
manduinca:docs/kinematics-equations-to-notes

Conversation

@manduinca

Copy link
Copy Markdown

Description Of Changes

Scoped to metpy.calc.kinematics for a focused first pass at #2677. Moves the equation blocks and implementation details out of the function description (above Parameters) and into the Notes section, so they render below Parameters/Returns.

Affects frontogenesis, storm_relative_helicity, potential_vorticity_baroclinic, potential_vorticity_barotropic, inertial_advective_wind and q_vector. This leaves the module consistent with the pattern already used here by vorticity, divergence, advection and total_deformation.

potential_vorticity_barotropic and q_vector had no Notes section, 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

@manduinca
manduinca requested a review from a team as a code owner July 16, 2026 03:57
@manduinca
manduinca requested review from dopplershift and removed request for a team July 16, 2026 03:57
@CLAassistant

CLAassistant commented Jul 16, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

Move equations to Notes

2 participants