diff --git a/doc/changes/dev/13811.other.rst b/doc/changes/dev/13811.other.rst new file mode 100644 index 00000000000..2fc02aefcca --- /dev/null +++ b/doc/changes/dev/13811.other.rst @@ -0,0 +1 @@ +Added cross-references to common modification methods in :class:`mne.Info` docstring. diff --git a/mne/_fiff/meas_info.py b/mne/_fiff/meas_info.py index fbb602caf2f..0d7e9e7e6c8 100644 --- a/mne/_fiff/meas_info.py +++ b/mne/_fiff/meas_info.py @@ -1286,6 +1286,18 @@ class Info(ValidatedDict, SetChannelsMixin, MontageMixin, ContainsMixin): modified by various MNE-Python functions or methods (which have safeguards to ensure all fields remain in sync). + Some common methods that safely modify the ``info`` object include: + * :meth:`mne.io.Raw.add_proj`, :meth:`mne.Epochs.add_proj`, + :meth:`mne.Evoked.add_proj` + * :meth:`mne.io.Raw.del_proj`, :meth:`mne.Epochs.del_proj`, + :meth:`mne.Evoked.del_proj` + * :meth:`mne.io.Raw.set_channel_types`, + :meth:`mne.Epochs.set_channel_types`, + :meth:`mne.Evoked.set_channel_types` + * :meth:`mne.io.Raw.set_meas_date`, + :meth:`mne.Epochs.set_meas_date`, + :meth:`mne.Evoked.set_meas_date` + Parameters ---------- *args : list