fixes obspy#2901 by adding more info to a docstring

QuLogic · Mar 9, 2022 · 3e2ef7d · 3e2ef7d
1 parent 759c790
commit 3e2ef7d
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/obspy/signal/util.py b/obspy/signal/util.py
@@ -124,6 +124,7 @@ def enframe(x, win, inc):
     of inc. Each frame is multiplied by the window win().
     The length of the frames is given by the length of the window win().
     The centre of frame I is x((I-1)*inc+(length(win)+1)/2) for I=1,2,...
+    The mean is also subtracted from each individual frame.
 
     :param x: signal to split in frames
     :param win: window multiplied to each frame, length determines frame length