Skip to content

Commit d6839bb

Browse files
Update mne/utils/docs.py
doc: reformat reference channel note for clarity Co-authored-by: Thomas S. Binns <t.s.binns@outlook.com>
1 parent a2eb16c commit d6839bb

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

mne/utils/docs.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4106,11 +4106,12 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
41064106
EEG signal by setting ``ref_channels='average'``. Bad EEG channels are
41074107
automatically excluded if they are properly set in ``info['bads']``.
41084108
4109-
"add_reference_channels_note": """.. note:: When performing average referencing in sensor-space analyses and the
4110-
original reference electrode is not present as a zero-filled channel,
4111-
this must first be added using :func:`~mne.add_reference_channels`
4112-
before calling :func:`~mne.set_eeg_reference` to avoid biasing the
4113-
reference :footcite:`AppelhoffSanderson2023`. """,
4109+
.. note::
4110+
When performing average referencing in sensor-space analyses and the original
4111+
reference electrode is not present as a zero-filled channel, this must first be
4112+
added using :func:`~mne.add_reference_channels`, before calling
4113+
:func:`~mne.set_eeg_reference`. This is necessary to avoid biasing the reference
4114+
:footcite:`AppelhoffSanderson2023`.
41144115
41154116
- A single electrode:
41164117
Set ``ref_channels`` to a list containing the name of the channel that

0 commit comments

Comments
 (0)