Skip to content

Commit

Permalink
Update docstring on the dimensions of the wind field
Browse files Browse the repository at this point in the history
Co-authored-by: jthielen <[email protected]>
  • Loading branch information
Z-Richard and jthielen authored Jun 30, 2023
1 parent 40d08e2 commit 890c1c3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/metpy/calc/kinematics.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,9 @@ def advection(
parallel_scale=None,
meridional_scale=None
):
r"""Calculate the advection of a scalar field by the wind.
r"""Calculate the advection of a scalar field by 1D, 2D, or 3D winds.
If ``scalar`` is a `xarray.DataArray`, only ``u``, ``v``, and ``w`` are required
If ``scalar`` is a `xarray.DataArray`, only ``u``, ``v``, and/or ``w`` are required
to compute advection. The horizontal and vertical spacing (``dx``, ``dy``, and ``dz``)
and axis numbers (``x_dim``, ``y_dim``, and ``z_dim``) are automatically inferred from
``scalar``. But if ``scalar`` is a `pint.Quantity`, the horizontal and vertical
Expand Down

0 comments on commit 890c1c3

Please sign in to comment.