Skip to content

Commit 802a0ca

Browse files
authored
Shorten docstring
1 parent 802b6e4 commit 802a0ca

1 file changed

Lines changed: 2 additions & 4 deletions

File tree

gsw/stability.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,10 @@ def Nsquared(SA, CT, p, lat=None, axis=0):
4747
Returns
4848
-------
4949
N2 : array
50-
Buoyancy frequency-squared at pressure midpoints, rad^2/s^2.
50+
Buoyancy frequency-squared at pressure midpoints, 1/s^2.
5151
The shape along the pressure axis dimension is one
5252
less than that of the inputs.
53-
The units of N2 are radians2 s-2 however in may textbooks this is
54-
abbreviated to s-2 as radians does not have a unit. To convert the
55-
frequency to hertz, cycles sec-1, divide the frequency by 2π, ie N/(2π).
53+
(Frequency N is in radians per second.)
5654
p_mid : array
5755
Pressure at midpoints of p, dbar.
5856
The array shape matches N2.

0 commit comments

Comments
 (0)