Add example to PW docstring #1227
Merged
Conversation
This file contains 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
zbruick
added
Area: Docs
dopplershift
reviewed
Nov 5, 2019
src/metpy/calc/indices.py
Outdated
| Examples | ||
| -------- | ||
| >>> pressure = np.array([1000, 950, 900]) * units.hPa | ||
| >>> dewpoint = np.array([20,15,10]) * units.degC |
There was a problem hiding this comment.
I guess we’re not flake8-ing the docstrings. Pedantic, but should be spaces after the commas.
There was a problem hiding this comment.
Good catch - I agree that it helps with reading comprehension.
dopplershift
approved these changes
Nov 5, 2019
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
Adds an example to the PW doctoring on usage to clarify that an array of points is needed to calculate PW, due to the fact that it's derived via integration.
Checklist