diff --git a/doc/changes/dev/13811.other.rst b/doc/changes/dev/13811.other.rst new file mode 100644 index 00000000000..42bc37f36e5 --- /dev/null +++ b/doc/changes/dev/13811.other.rst @@ -0,0 +1 @@ +Added cross-references to common modification methods in :class:`mne.Info` docstring by :newcontrib:`Athish M`. \ No newline at end of file diff --git a/doc/changes/names.inc b/doc/changes/names.inc index a664a36c5ed..86f71d63de2 100644 --- a/doc/changes/names.inc +++ b/doc/changes/names.inc @@ -34,6 +34,7 @@ .. _Arne Pelzer: https://github.com/aplzr .. _Ashley Drew: https://github.com/ashdrew .. _Asish Panda: https://github.com/kaichogami +.. _Athish M: https://github.com/athishdresu .. _Austin Hurst: https://github.com/a-hurst .. _Ayushi Satodiya: https://github.com/ayuclan .. _Baris Talar: https://github.com/baris-talar diff --git a/mne/_fiff/meas_info.py b/mne/_fiff/meas_info.py index c76e757fff7..32ac823205e 100644 --- a/mne/_fiff/meas_info.py +++ b/mne/_fiff/meas_info.py @@ -1298,6 +1298,22 @@ 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.rename_channels`, + :meth:`mne.Epochs.rename_channels`, + :meth:`mne.Evoked.rename_channels` + * :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