From b8cb797547a453d09949ec0beed10fb80646e89d Mon Sep 17 00:00:00 2001 From: Deep Kaur Date: Wed, 8 Apr 2026 15:49:44 +0530 Subject: [PATCH 1/3] DOC: Clarify add_reference_channels usage with average reference --- mne/channels/channels.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/mne/channels/channels.py b/mne/channels/channels.py index c1a3d462525..002b4d42a73 100644 --- a/mne/channels/channels.py +++ b/mne/channels/channels.py @@ -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) From e270d35644946145e64bf2aafdd2eca3fa7e013f Mon Sep 17 00:00:00 2001 From: Deep Kaur Date: Thu, 16 Apr 2026 19:31:06 +0530 Subject: [PATCH 2/3] DOC: take over #13664 to clarify avg behavior and add towncrier --- doc/changes/dev/13618.notable.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changes/dev/13618.notable.rst diff --git a/doc/changes/dev/13618.notable.rst b/doc/changes/dev/13618.notable.rst new file mode 100644 index 00000000000..10202f8c55a --- /dev/null +++ b/doc/changes/dev/13618.notable.rst @@ -0,0 +1 @@ +Clarify average EEG reference behavior in documentation for add_reference_channels. \ No newline at end of file From 5ecd0c029eb57886cb60435b3e55fa94c4021e9d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 16 Apr 2026 14:15:35 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- mne/channels/channels.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mne/channels/channels.py b/mne/channels/channels.py index 002b4d42a73..c8ee5f74d57 100644 --- a/mne/channels/channels.py +++ b/mne/channels/channels.py @@ -812,7 +812,7 @@ 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`