From 7e05fdc0669c4666c596935252edb2ab284755e1 Mon Sep 17 00:00:00 2001
From: fraserwg <fraser.goldsworth@st-annes.ox.ac.uk>
Date: Thu, 9 Feb 2023 10:29:24 +0100
Subject: [PATCH] fixed docstring typo
---
pyicon/pyicon_calc_xr.py | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/pyicon/pyicon_calc_xr.py b/pyicon/pyicon_calc_xr.py
index 26bb740..e472eda 100644
--- a/pyicon/pyicon_calc_xr.py
+++ b/pyicon/pyicon_calc_xr.py
@@ -480,9 +480,10 @@ def xr_calc_curl(ds_IcD, vector, rot_coeff=None):
Notes
-----
- We calculate the curl through the use of Stokes'/Green's theorem
- Green's theorem as we're working with 2D velocity!), A similar procedure can be used to calculate the horizontal components of the curl (oriented
- along cell edges and defined at intermediate Z levels.) This will be implemented in a future release.
+ We calculate the curl through the use of Stokes'/Green's theorem. A similar
+ procedure can be used to calculate the horizontal components of the curl
+ (oriented along cell edges and defined at intermediate Z levels.) This will
+ be implemented in a future release.
If you're using this function on large datasets, performance gains may be
made if you play around with the dimension order.
--
GitLab