Skip to content
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.

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

apply_function docstring wrong for epochs? #13118

Open
sappelhoff opened this issue Feb 18, 2025 · 0 comments
Open

apply_function docstring wrong for epochs? #13118

sappelhoff opened this issue Feb 18, 2025 · 0 comments
Labels

Comments

@sappelhoff
Copy link
Member

see: https://mne.tools/dev/generated/mne.Epochs.html#mne.Epochs.apply_function

Image

☝ what is said here does not correspond to the actual data shape of epochs (3D arrays). So it is actually confusing how the passed function would deal with the epochs dimension.

See also:

%(fun_applyfun)s

mne-python/mne/utils/docs.py

Lines 1863 to 1871 in 64e01e5

docdict["fun_applyfun"] = applyfun_fun_base.format(
" if ``channel_wise=True`` and ``(len(picks), n_times)`` otherwise"
)
docdict["fun_applyfun_evoked"] = applyfun_fun_base.format(
" because it will apply channel-wise"
)
docdict["fun_applyfun_stc"] = applyfun_fun_base.format(
" because it will apply vertex-wise"
)

@sappelhoff sappelhoff added the DOC label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant