Skip to content

Fix apply_function docstring for Epochs #13118 #13136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix apply_function docstring for Epochs #13118 #13136

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23573ec
DOC: Fix apply_function docstring for Epochs #13118
Imama-Kainat Mar 1, 2025
0f0c8c9
Merge branch 'main' into fix-applyfun-docstring
Imama-Kainat Mar 1, 2025
ad84e40
Merge branch 'main' into fix-applyfun-docstring
Imama-Kainat Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mne/utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1861,7 +1861,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
additional argument(s) to your function definition.
"""
docdict["fun_applyfun"] = applyfun_fun_base.format(
" if ``channel_wise=True`` and ``(len(picks), n_times)`` otherwise"
" if ``channel_wise=True`` then a 3D array of shape ``(n_epochs, len(picks), n_times)`` is passed, otherwise a 3D array of shape ``(n_epochs, n_channels, n_times)`` is passed"
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't quite right, because this change will be reflected in the documentation for raw.apply_function and evoked.apply_function, but we don't want it to, since those data will never be 3D!

e.g. see https://output.circle-artifacts.com/output/job/118b9184-1aa0-461c-a3a6-7f831deca1ee/artifacts/0/html/generated/mne.io.Raw.html#mne.io.Raw.apply_function

docdict["fun_applyfun_evoked"] = applyfun_fun_base.format(
" because it will apply channel-wise"
Expand Down
Loading