Update shear function docstrings

jmcvey3 · May 31, 2024 · edb722d · edb722d
1 parent d5c8914
commit edb722d
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/dolfyn/adp/turbulence.py b/dolfyn/adp/turbulence.py
@@ -71,15 +71,15 @@ 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:]
 
         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
         -----