Skip to content

Commit

Permalink
fix missing section; little tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
drammock committed Oct 6, 2023
1 parent 5ebd9a1 commit 4038681
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
"path-like": ":term:`path-like`",
"array-like": ":term:`array_like <numpy:array_like>`",
"Path": ":class:`python:pathlib.Path`",
"bool": ":class:`python:bool`",
"bool": ":class:`bool <python:bool>`",
# Matplotlib
"colormap": ":ref:`colormap <matplotlib:colormaps>`",
"color": ":doc:`color <matplotlib:api/colors_api>`",
Expand Down
9 changes: 5 additions & 4 deletions mne/time_frequency/tfr.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ def morlet(sfreq, freqs, n_cycles=7.0, sigma=None, zero_mean=False):
Notes
-----
%(morlet_notes)s
%(morlet_reference)s
%(fwhm_morlet_notes)s
References
Expand Down Expand Up @@ -948,7 +948,8 @@ def tfr_morlet(
Notes
-----
%(morlet_notes)s
%(morlet_reference)s
%(temporal_window_tfr_intro)s
%(temporal_window_tfr_morlet_notes)s
See :func:`mne.time_frequency.morlet` for more information about the
Expand Down Expand Up @@ -996,7 +997,7 @@ def tfr_array_morlet(
Sampling frequency of the data.
%(freqs_tfr)s
%(n_cycles_tfr)s
zero_mean : bool | False
zero_mean : bool
If True, make sure the wavelets have a mean of zero. default False.
use_fft : bool
Use the FFT for convolutions or not. default True.
Expand Down Expand Up @@ -1038,7 +1039,7 @@ def tfr_array_morlet(
Notes
-----
%(morlet_notes)s
%(morlet_reference)s
%(temporal_window_tfr_intro)s
%(temporal_window_tfr_morlet_notes)s
Expand Down
7 changes: 3 additions & 4 deletions mne/utils/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1829,7 +1829,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
of the wavelet is determined by the ``sigma`` parameter, which gives the
standard deviation of the wavelet's Gaussian envelope (our wavelets extend to
±5 standard deviations to ensure values very close to zero at the endpoints).
Some authors (e.g., :footcite:`Cohen2019`) recommend specifying and reporting
Some authors (e.g., :footcite:t:`Cohen2019`) recommend specifying and reporting
wavelet duration in terms of the full-width half-maximum (FWHM) of the
wavelet's Gaussian envelope. The FWHM is related to ``sigma`` by the following
identity: :math:`\mathrm{FWHM} = \sigma \times 2 \sqrt{2 \ln{2}}` (or the
Expand Down Expand Up @@ -2668,10 +2668,9 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
"""

docdict[
"morlet_notes"
"morlet_reference"
] = """
The Morlet wavelets follow the formulation in
:footcite:`Tallon-BaudryEtAl1997`.
The Morlet wavelets follow the formulation in :footcite:t:`Tallon-BaudryEtAl1997`.
"""

docdict[
Expand Down

0 comments on commit 4038681

Please sign in to comment.