DOC: move eLORETA-specific note out of the template %(depth)s docstring - #13996
Merged
Conversation
larsoner
approved these changes
Jun 28, 2026
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
2 participants
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)
None.
What does this implement/fix?
This small PR moves one sentence ("This is effectively ignored when
method='eLORETA'") from the docstring ofdepthparameter tomne.minimum_norm.make_inverse_operator, which is the only place where it actually applies. The docstring itself is also re-used inmne.beamformer.make_lcmv,mne.beamformer.make_dics,mne.inverse_sparse.gamma_map,mne.inverse_sparse.mixed_norm, andmne.inverse_sparse.tf_mixed_norm, but in all those places it is rather a bit confusing, since none of the functions have amethodparameter.Additional information
I built the docs locally, and the changes also look as intended in the rendered HTML. Due to small scope, I omitted the changelog entry, but I can add it if you think it's worth mentioning. For the same reason, I skipped creating an issue on this, which is hopefully fine.