Repository navigation
DOC: Move geopotential conversion equations into Notes - #4181
Open
miao010625 wants to merge 2 commits into
Open
miao010625 wants to merge 2 commits into
miao010625 wants to merge 2 commits into
Conversation
miao010625
marked this pull request as ready for review
October 22, 2026 10:31
This was referenced Oct 22, 2026
Closed
This branch has not been deployed
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
The main equations for
height_to_geopotentialandgeopotential_to_heightcurrently appear beforeParameters. Move them, their derivation references, and their symbol definitions into the existingNotessections, so users reach the parameters and return values first.This is a focused contribution toward #2677, scoped to the geopotential conversion pair in
metpy.calc.basic. It does not close the broader issue. Equations, signatures, implementation, and examples are unchanged.Validation
python -m pytest tests/calc/test_basic.py -k geopotential -q: 10 passed, 132 deselected.git diff --check: passed.Checklist
Prepared with AI assistance. Opened as a draft for the contributor's review before requesting maintainer review.