DOC: Move equations to Notes in stability index docstrings#4099
Open
manduinca wants to merge 1 commit into
Open
DOC: Move equations to Notes in stability index docstrings#4099manduinca wants to merge 1 commit into
manduinca wants to merge 1 commit into
Conversation
Part of Unidata#2677. Follows the pattern of Unidata#4095 (kinematics): move the equation blocks, term definitions, and implementation notes that appeared before the Parameters section into the Notes section, so they render below the parameter and return documentation. Affects the stability/severe-weather indices in calc/thermo.py: lifted_index, k_index, galvez_davison_index, showalter_index, total_totals_index, vertical_totals, cross_totals, and sweat_index.
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
1 participant
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
Follow-up to #4095, applying the same #2677 pattern to
metpy.calc.thermo. Moves the equation blocks, term definitions and implementation notes out of the function description (aboveParameters) and into theNotessection, so they render belowParameters/Returns.Scoped to the stability / severe-weather indices for a focused pass:
lifted_index,k_index,galvez_davison_index,showalter_index,total_totals_index,vertical_totals,cross_totalsandsweat_index. None of these had aNotessection, so I added one to each. Forgalvez_davison_indexthe convective-regime.. list-table::moved along with the equation;sweat_indexhad noExamples, so itsNotesgoes at the end of the docstring.Docstrings only — no code, signatures or behaviour changed, and the doctests are untouched. Happy to continue with the remaining
thermofunctions andindicesin separate PRs.Checklist