Skip to content

DOC: clarify add_reference_channels usage (Takeover #13664) #13846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dpereaptkhamur-13 wants to merge 5 commits into
base: main
Choose a base branch
from
+7 −0
Open

DOC: clarify add_reference_channels usage (Takeover #13664) #13846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8cb797
DOC: Clarify add_reference_channels usage with average reference
Dpereaptkhamur-13 Apr 8, 2026
e270d35
DOC: take over #13664 to clarify avg behavior and add towncrier
Dpereaptkhamur-13 Apr 16, 2026
5ecd0c0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 16, 2026
f261a66
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 Apr 16, 2026
2231721
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13618.notable.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify average EEG reference behavior in documentation for add_reference_channels.
6 changes: 6 additions & 0 deletions mne/channels/channels.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -812,6 +812,12 @@ def add_reference_channels(self, ref_channels):
-------
inst : same type as the input data
The modified instance.
note:: If you are adding a new reference channel to data that
will eventually be used with an average reference,
you should also call :meth:`mne.io.Raw.set_eeg_reference`
(or the equivalent Epochs/Evoked method) to ensure the
mathematical reference is updated correctly.
"""
return add_reference_channels(self, ref_channels, copy=False)

Expand Down