updated docstrings

librosa/core/spectrum.py

@@ -53,8 +53,8 @@ def stft(y, n_fft=2048, hop_length=None, win_length=None, window='hann',
 
         If unspecified, defaults to ``win_length = n_fft``.
 
-    window : None, function, np.ndarray [shape=(n_fft,)]
-        - None (default): use an asymmetric Hann window
+    window : string, tuple, function, or np.ndarray [shape=(n_fft,)]
+        - a window specification (string or tuple); see `scipy.signal.get_window`
         - a window function, such as `scipy.signal.hanning`
         - a vector or array of length `n_fft`
 
@@ -205,8 +205,8 @@ def istft(stft_matrix, hop_length=None, win_length=None, window='hann',
 
         If unspecified, defaults to `n_fft`.
 
-    window      : None, function, np.ndarray [shape=(n_fft,)]
-        - None (default): use an asymmetric Hann window
+    window      : string, tuple, function, np.ndarray [shape=(n_fft,)]
+        - a window specification (string or tuple); see `scipy.signal.get_window`
         - a window function, such as `scipy.signal.hanning`
         - a user-specified window vector of length `n_fft`
 
@@ -324,8 +324,10 @@ def ifgram(y, sr=22050, n_fft=2048, hop_length=None, win_length=None,
         Window length. Defaults to `n_fft`.
         See `stft` for details.
 
-    window : string, tuple, function, or np.ndarray
-        Window function to use in ifgram calculation.
+    window : string, tuple, function, or np.ndarray [shape=(n_fft,)]
+        - a window specification (string or tuple); see `scipy.signal.get_window`
+        - a window function, such as `scipy.signal.hanning`
+        - a user-specified window vector of length `n_fft`
         See `stft` for details.
 
     norm : bool

librosa/feature/rhythm.py

@@ -49,8 +49,7 @@ def tempogram(y=None, sr=22050, onset_envelope=None, hop_length=512,
         If `False`, windows are left-aligned.
 
     window : string, function, tuple, or np.ndarray [shape=(win_length,)]
-        Window function to apply to onset strength function.
-        By default an asymmetric Hann window.
+        A window specification as in `core.stft`
 
     norm : {np.inf, -np.inf, 0, float > 0, None}
         Normalization mode.  Set to `None` to disable normalization.

librosa/filters.py

@@ -758,7 +758,10 @@ def window_bandwidth(window, default=1.0):
 
 @cache(level=10)
 def get_window(window, Nx, fftbins=True):
-    '''Compute a window function
+    '''Compute a window function.
+
+    This is a wrapper for `scipy.signal.get_window` that additionally
+    supports callable or pre-computed windows.
 
     Parameters
     ----------
@@ -798,7 +801,7 @@ def get_window(window, Nx, fftbins=True):
         return window(Nx)
 
     elif isinstance(window, (str, tuple)):
-        # TODO: if we add more window functions, put that index check here
+        # TODO: if we add custom window functions in librosa, call them here
 
         return scipy.signal.get_window(window, Nx, fftbins=fftbins)
     elif isinstance(window, (np.ndarray, list)):