Skip to content

DOC: Move geopotential conversion equations into Notes - #4181

Open
miao010625 wants to merge 2 commits into
Unidata:mainfrom
miao010625:codex/docs-geopotential-notes
Open

miao010625 wants to merge 2 commits into
Unidata:mainfrom
miao010625:codex/docs-geopotential-notes

Conversation

@miao010625

Copy link
Copy Markdown

Description Of Changes

The main equations for height_to_geopotential and geopotential_to_height currently appear before Parameters. Move them, their derivation references, and their symbol definitions into the existing Notes sections, 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.
  • Focused Sphinx 9.0.4 HTML build of both API docstrings using autodoc, napoleon, and mathjax, with warnings treated as errors: passed with no warnings. The full project documentation build was not run.
  • AST comparison after removing docstrings: executable code unchanged.
  • git diff --check: passed.

Checklist

  • Part of Move equations to Notes #2677; other functions remain outside this PR.
  • Documentation updated.
  • No new tests added for this documentation-only change; relevant existing tests were run.

Prepared with AI assistance. Opened as a draft for the contributor's review before requesting maintainer review.

@CLAassistant

CLAassistant commented Oct 22, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@miao010625
miao010625 marked this pull request as ready for review October 22, 2026 10:31
@miao010625
miao010625 requested a review from a team as a code owner October 22, 2026 10:31
@miao010625
miao010625 requested review from dcamron and removed request for a team October 22, 2026 10:31

This branch has not been deployed

No deployments
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