DOC: Fix apply_function shape description for Epochs (#13118)#13891
Open
bkowshik wants to merge 1 commit intomne-tools:mainfrom
Open
DOC: Fix apply_function shape description for Epochs (#13118)#13891bkowshik wants to merge 1 commit intomne-tools:mainfrom
bkowshik wants to merge 1 commit intomne-tools:mainfrom
Conversation
The fun parameter docstring for mne.Epochs.apply_function incorrectly stated that the array passed to the user's function when channel_wise=False has shape (len(picks), n_times). The actual shape is (n_epochs, n_channels, n_times). Adds a new fun_applyfun_epochs docdict entry alongside fun_applyfun_evoked and fun_applyfun_stc, leaving the Raw docstring (where (len(picks), n_times) is correct) untouched. Per scott-huberty's review suggestion on mne-tools#13136. Fixes mne-tools#13118
bkowshik
requested review from
agramfort,
drammock and
mscheltienne
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference issue (if any)
What does this implement/fix?
The
funparameter docstring formne.Epochs.apply_functionincorrectly stated that the array passed to the user's function whenchannel_wise=Falsehas shape(len(picks), n_times). The actual shape is(n_epochs, n_channels, n_times). Adds a newfun_applyfun_epochsdocdict entry alongsidefun_applyfun_evokedandfun_applyfun_stc, leaving the Raw docstring (where(len(picks), n_times)is correct) untouched.Documentation post the fix looks like below:
cd doc make html-noplot make showAdditional information
Have used Claude Code to understand the issue, identify the location of fix, commands to build locally for testing.