Skip to content

Commit 8e64680

Browse files
authored
DOC: move eLORETA-specific note out of the template %(depth)s docstring (#13996)
1 parent 7e9310f commit 8e64680

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

mne/minimum_norm/inverse.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1893,7 +1893,10 @@ def make_inverse_operator(
18931893
:func:`~mne.compute_covariance` to compute the noise covariance matrix on
18941894
:class:`~mne.io.Raw` and :class:`~mne.Epochs` respectively.
18951895
%(loose)s
1896-
%(depth)s
1896+
%(depth)s This is effectively ignored when ``method='eLORETA'``.
1897+
1898+
.. versionchanged:: 0.20
1899+
Depth bias ignored for ``method='eLORETA'``.
18971900
fixed : bool | 'auto'
18981901
Use fixed source orientations normal to the cortical mantle. If True,
18991902
the loose parameter must be ``"auto"`` or ``0``. If ``'auto'``, the loose value

mne/utils/docs.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1170,13 +1170,10 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
11701170
depth : None | float | dict
11711171
How to weight (or normalize) the forward using a depth prior.
11721172
If float (default 0.8), it acts as the depth weighting exponent (``exp``)
1173-
to use None is equivalent to 0, meaning no depth weighting is performed.
1173+
to use. None is equivalent to 0, meaning no depth weighting is performed.
11741174
It can also be a :class:`dict` containing keyword arguments to pass to
11751175
:func:`mne.forward.compute_depth_prior` (see docstring for details and
1176-
defaults). This is effectively ignored when ``method='eLORETA'``.
1177-
1178-
.. versionchanged:: 0.20
1179-
Depth bias ignored for ``method='eLORETA'``.
1176+
defaults).
11801177
"""
11811178

11821179
docdict["destination_maxwell_dest"] = """

0 commit comments

Comments
 (0)