Skip to content

Commit c18908c

Browse files
authored
DOC: improve See Also xrefs, remove wrong Note (#13226)
1 parent d089b45 commit c18908c

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

mne/channels/channels.py

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,11 @@ def equalize_channels(instances, copy=True, verbose=None):
136136
A list of MNE-Python objects that have the same channels defined in the
137137
same order.
138138
139-
Notes
140-
-----
141-
This function operates inplace.
139+
See Also
140+
--------
141+
mne.channels.unify_bad_channels
142+
mne.channels.rename_channels
143+
mne.channels.combine_channels
142144
"""
143145
from ..cov import Covariance
144146
from ..epochs import BaseEpochs
@@ -1126,6 +1128,12 @@ def rename_channels(info, mapping, allow_duplicates=False, *, verbose=None):
11261128
%(info_not_none)s Note: modified in place.
11271129
%(mapping_rename_channels_duplicates)s
11281130
%(verbose)s
1131+
1132+
See Also
1133+
--------
1134+
mne.channels.equalize_channels
1135+
mne.channels.unify_bad_channels
1136+
mne.channels.combine_channels
11291137
"""
11301138
_validate_type(info, Info, "info")
11311139
info._check_consistency()
@@ -2032,6 +2040,12 @@ def combine_channels(
20322040
An MNE-Python object of the same type as the input ``inst``, containing
20332041
one virtual channel for each group in ``groups`` (and, if ``keep_stim``
20342042
is ``True``, also containing stimulus channels).
2043+
2044+
See Also
2045+
--------
2046+
mne.channels.equalize_channels
2047+
mne.channels.rename_channels
2048+
mne.channels.unify_bad_channels
20352049
"""
20362050
from ..epochs import BaseEpochs, EpochsArray
20372051
from ..evoked import Evoked, EvokedArray

0 commit comments

Comments
 (0)