diff --git a/doc/changes/dev/13891.other.rst b/doc/changes/dev/13891.other.rst new file mode 100644 index 00000000000..4c60a55c67d --- /dev/null +++ b/doc/changes/dev/13891.other.rst @@ -0,0 +1 @@ +Fixed the ``fun`` shape description in :meth:`mne.Epochs.apply_function`'s docstring, by :newcontrib:`Bhargav Kowshik`. diff --git a/doc/changes/names.inc b/doc/changes/names.inc index e20fad63acb..86644392e3b 100644 --- a/doc/changes/names.inc +++ b/doc/changes/names.inc @@ -40,6 +40,7 @@ .. _Beige Jin: https://github.com/BeiGeJin .. _Ben Beasley: https://github.com/musicinmybrain .. _Benedikt Ehinger: https://www.benediktehinger.de +.. _Bhargav Kowshik: https://github.com/bkowshik .. _Bradley Voytek: https://github.com/voytek .. _Britta Westner: https://britta-wstnr.github.io .. _Bruno Aristimunha: https://bruaristimunha.github.io diff --git a/mne/epochs.py b/mne/epochs.py index 8aaf1316305..442359f3d65 100644 --- a/mne/epochs.py +++ b/mne/epochs.py @@ -1974,7 +1974,7 @@ def apply_function( Parameters ---------- - %(fun_applyfun)s + %(fun_applyfun_epochs)s %(picks_all_data_noref)s %(dtype_applyfun)s %(n_jobs)s Ignored if ``channel_wise=False`` as the workload diff --git a/mne/utils/docs.py b/mne/utils/docs.py index fac59e0852f..98fac7232ae 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -1919,6 +1919,11 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75): docdict["fun_applyfun"] = applyfun_fun_base.format( " if ``channel_wise=True`` and ``(len(picks), n_times)`` otherwise" ) +docdict["fun_applyfun_epochs"] = applyfun_fun_base.format( + " if ``channel_wise=True`` (because it will apply to 1-D" + " slices along the times axis) and" + " ``(n_epochs, len(picks), n_times)`` otherwise" +) docdict["fun_applyfun_evoked"] = applyfun_fun_base.format( " because it will apply channel-wise" )