From 890c1c364ce1434f8406fb8be171b784bfbc4219 Mon Sep 17 00:00:00 2001 From: Richard Zhuang <38182337+Z-Richard@users.noreply.github.com> Date: Fri, 30 Jun 2023 09:06:19 +0800 Subject: [PATCH] Update docstring on the dimensions of the wind field Co-authored-by: jthielen --- src/metpy/calc/kinematics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/metpy/calc/kinematics.py b/src/metpy/calc/kinematics.py index 66235dc71af..853e0ceeb86 100644 --- a/src/metpy/calc/kinematics.py +++ b/src/metpy/calc/kinematics.py @@ -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