Skip to content

Commit 890c1c3

Browse files
Z-Richardjthielen
andauthored
Update docstring on the dimensions of the wind field
Co-authored-by: jthielen <jt@thielen.science>
1 parent 40d08e2 commit 890c1c3

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/metpy/calc/kinematics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,9 +376,9 @@ def advection(
376376
parallel_scale=None,
377377
meridional_scale=None
378378
):
379-
r"""Calculate the advection of a scalar field by the wind.
379+
r"""Calculate the advection of a scalar field by 1D, 2D, or 3D winds.
380380
381-
If ``scalar`` is a `xarray.DataArray`, only ``u``, ``v``, and ``w`` are required
381+
If ``scalar`` is a `xarray.DataArray`, only ``u``, ``v``, and/or ``w`` are required
382382
to compute advection. The horizontal and vertical spacing (``dx``, ``dy``, and ``dz``)
383383
and axis numbers (``x_dim``, ``y_dim``, and ``z_dim``) are automatically inferred from
384384
``scalar``. But if ``scalar`` is a `pint.Quantity`, the horizontal and vertical

0 commit comments

Comments
 (0)