From 244d6e30f48a975e0ab7e09c22f1697f31cdbd61 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Fri, 3 Nov 2023 09:39:16 -0400 Subject: [PATCH] Apply suggestions from code review --- doc/changes/devel.rst | 2 +- mne/_fiff/reference.py | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/changes/devel.rst b/doc/changes/devel.rst index a5537dd3eda..266c4e5ef90 100644 --- a/doc/changes/devel.rst +++ b/doc/changes/devel.rst @@ -45,7 +45,7 @@ Enhancements - Add :class:`mne.viz.ui_events.UIEvent` linking for interactive colorbars, allowing users to link figures and change the colormap and limits interactively. This supports :func:`~mne.viz.plot_evoked_topomap`, :func:`~mne.viz.plot_ica_components`, :func:`~mne.viz.plot_tfr_topomap`, :func:`~mne.viz.plot_projs_topomap`, :meth:`~mne.Evoked.plot_image`, and :meth:`~mne.Epochs.plot_image` (:gh:`12057` by `Santeri Ruuskanen`_) - :func:`~mne.epochs.make_metadata` now accepts ``tmin=None`` and ``tmax=None``, which will bound the time window used for metadata generation by event names (instead of a fixed time). That way, you can now for example generate metadata spanning from one cue or fixation cross to the next, even if trial durations vary throughout the recording (:gh:`12118` by `Richard Höchenberger`_) - Add support for passing multiple labels to :func:`mne.minimum_norm.source_induced_power` (:gh:`12026` by `Erica Peterson`_, `Eric Larson`_, and `Daniel McCloy`_ ) -- Added documentation to :func:`mne.io.Raw.set_montage`and :func:`mne.add_reference_channels` to specify that montages should be set after adding reference channels (:gh:`12160` by `Jacob Woessner`_) +- Added documentation to :meth:`mne.io.Raw.set_montage`and :func:`mne.add_reference_channels` to specify that montages should be set after adding reference channels (:gh:`12160` by `Jacob Woessner`_) Bugs ~~~~ diff --git a/mne/_fiff/reference.py b/mne/_fiff/reference.py index 856059c86be..9efa23abe15 100644 --- a/mne/_fiff/reference.py +++ b/mne/_fiff/reference.py @@ -179,9 +179,8 @@ def add_reference_channels(inst, ref_channels, copy=True): Notes ----- .. warning:: - When :doc:`re-referencing - ` - , make sure to apply the montage using :func:`mne.io.Raw.set_montage` + When :ref:`re-referencing `, + 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. """