updated docstring for shoaling coeff.

NOAA-ORR-ERD · Aug 1, 2016 · 5e87653 · 5e87653
1 parent 4075955
commit 5e87653
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/wave_utils/waves.py b/wave_utils/waves.py
@@ -153,6 +153,9 @@ def shoaling_coeff(omega, g, h0, h2):
 
     Compute the shoaling coeff for two depths: ho and h2.
 
+    The shoaling coeff is the ratio of wave height (H2) at a particular
+    point of interest to the original or deep water wave height (H0).
+
     Pass in h0 = None for deep water
 
     :param omega: -- the wave frequency