From edb722d8fdc15318cf7bd06b40d3b187a9d097f6 Mon Sep 17 00:00:00 2001
From: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>
Date: Thu, 30 May 2024 17:03:33 -0700
Subject: [PATCH] Update shear function docstrings
---
dolfyn/adp/turbulence.py | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/dolfyn/adp/turbulence.py b/dolfyn/adp/turbulence.py
index d11003a3..2089f547 100644
--- a/dolfyn/adp/turbulence.py
+++ b/dolfyn/adp/turbulence.py
@@ -71,7 +71,7 @@ def _diff_func(self, vel, u, orientation):
sign = 1
if orientation == 'down':
sign *= -1
-
+
if self.diff_style == 'first':
out = _diffz_first(vel[u].values, vel['range'].values)
return sign*out, vel.range[1:]
@@ -79,7 +79,7 @@ def _diff_func(self, vel, u, orientation):
elif self.diff_style == 'centered':
out = _diffz_centered(vel[u].values, vel['range'].values)
return sign*out, vel.range[1:-1]
-
+
elif self.diff_style == 'centered_extended':
out = _diffz_centered_extended(vel[u].values, vel['range'].values)
return sign*out, vel.range
@@ -116,6 +116,8 @@ def calc_dvdz(self, vel, orientation=None):
----------
vel : xarray.DataArray
ADCP raw velocity
+ orientation : str, default=ADPBinner.orientation
+ Direction ADCP is facing ('up' or 'down')
Notes
-----
@@ -139,6 +141,8 @@ def calc_dwdz(self, vel, orientation=None):
----------
vel : xarray.DataArray
ADCP raw velocity
+ orientation : str, default=ADPBinner.orientation
+ Direction ADCP is facing ('up' or 'down')
Notes
-----