Add note in reference and change logger

withmywoessner · Nov 2, 2023 · 35fc066 · 35fc066
1 parent b341448
commit 35fc066
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/mne/_fiff/meas_info.py b/mne/_fiff/meas_info.py
@@ -412,10 +412,9 @@ def set_montage(
             functions.
         .. warning::
             Applying a montage will only set locations of channels that exist
-            at the time it is applied. This means when
-            :doc:`re-referencing
+            at the time it is applied. This means when :doc:`re-referencing
             </auto_tutorials/preprocessing/55_setting_eeg_reference>`
-            make sure to apply the montage after calling
+            make sure to apply the montage only after calling
             :func:`mne.add_reference_channels`
         """
         # How to set up a montage to old named fif file (walk through example)

diff --git a/mne/_fiff/reference.py b/mne/_fiff/reference.py
@@ -175,6 +175,15 @@ def add_reference_channels(inst, ref_channels, copy=True):
     -------
     inst : instance of Raw | Epochs | Evoked
         Data with added EEG reference channels.
+
+    Notes
+    -----
+    .. warning::
+        When :doc:`re-referencing
+        </auto_tutorials/preprocessing/55_setting_eeg_reference>`
+        , make sure to apply the montage using :func:`mne.io.Raw.set_montage`
+        only after calling this function. Applying a montage will only set
+        locations of channels that exist at the time it is applied.
     """
     from ..epochs import BaseEpochs
     from ..evoked import Evoked
@@ -239,7 +248,9 @@ def add_reference_channels(inst, ref_channels, copy=True):
         ref_dig_array = np.full(12, np.nan)
         logger.info(
             "Location for this channel is unknown; consider calling "
-            "set_montage() again if needed."
+            "set_montage() after adding new reference channels if needed. "
+            "Applying a montage will only set locations of channels that "
+            "exist at the time it is applied."
         )
 
     for ch in ref_channels: