updates docs for latitude units #1017
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
metpy/calc/kinematics.py
Outdated
| @@ -604,7 +604,7 @@ def absolute_vorticity(u, v, dx, dy, lats, dim_order='yx'): | |||
| The grid spacing(s) in the y-direction. If an array, there should be one item less than | |||
| the size of `u` along the applicable axis. | |||
| lats : (M, N) ndarray | |||
| latitudes of the wind data | |||
| latitudes of the wind data in radians or appropriately united | |||
There was a problem hiding this comment.
"in radians or with appropriate unit information attached"? We've used the attached idea elsewhere. I'm not sure of the proper spelling of "unit-ed"..."united"? The latter is spelled like the airline. I'm not sure if we're talking homographs or not.
There was a problem hiding this comment.
Yeah, that is exactly what I was thinking about when I was writing the initial draft and didn't like it too much either. I've implemented your version, which I think is still relatively succinct.
dopplershift
approved these changes
Mar 21, 2019
dopplershift
added
Type: Bug
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.
This PR updates the documentation of kinematic calculations to be clear that latitudes are needed in either radians or as an appropriately united array. Fixes issue #1010. Comments on a different formation of the wording is welcome.