Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
tsbinns committed Oct 22, 2024
1 parent 51b8cd0 commit b4537b2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions mne/time_frequency/multitaper.py
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,8 @@ def tfr_array_multitaper(
coherence across trials.
return_weights : bool, default False
If True, return the taper weights. Only applies if ``output="complex"``.
If True, return the taper weights. Only applies if ``output='complex'`` or
``'phase'``.
.. versionadded:: 1.9.0
Expand All @@ -528,7 +529,7 @@ def tfr_array_multitaper(
contain the average power and the imaginary values contain the
inter-trial coherence: :math:`out = power_{avg} + i * ITC`.
weights : array of shape (n_tapers, n_freqs)
The taper weights. Only returned if ``output="complex"`` and
The taper weights. Only returned if ``output='complex'`` or ``'phase'`` and
``return_weights=True``.
See Also
Expand Down

0 comments on commit b4537b2

Please sign in to comment.