Skip to content

Commit

Permalink
MNT: Change default dimension ordering for kinematics functions
Browse files Browse the repository at this point in the history
We already promised that we were going to do this, so we probably
should.
  • Loading branch information
dopplershift committed Jan 4, 2018
1 parent f477fdc commit 802138b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions metpy/calc/kinematics.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ def _stack(arrs):
def _is_x_first_dim(dim_order):
"""Determine whether x is the first dimension based on the value of dim_order."""
if dim_order is None:
warnings.warn('dim_order is using the default setting (currently "xy"). This will '
'change to "yx" in the next version. It is recommended that you '
warnings.warn('dim_order is using the default setting ("yx"). This changed in '
'version 0.7. It is recommended that you '
'specify the appropriate ordering ("xy", "yx") for your data by '
'passing the `dim_order` argument to the calculation.', FutureWarning)
dim_order = 'xy'
'passing the `dim_order` argument to the calculation.', UserWarning)
dim_order = 'yx'
return dim_order == 'xy'


Expand Down Expand Up @@ -78,7 +78,7 @@ def wrapper(*args, **kwargs):
or ``'yx'``. ``'xy'`` indicates that the dimension corresponding to x is the leading
dimension, followed by y. ``'yx'`` indicates that x is the last dimension, preceded
by y. ``None`` indicates that the default ordering should be assumed,
which will change in version 0.6 from 'xy' to 'yx'. Can only be passed as a keyword
which changed in version 0.7 from 'xy' to 'yx'. Can only be passed as a keyword
argument, i.e. func(..., dim_order='xy')."""

# Find the first blank line after the start of the parameters section
Expand Down

0 comments on commit 802138b

Please sign in to comment.