Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13811.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added cross-references to common modification methods in :class:mne.Info docstring.
12 changes: 12 additions & 0 deletions mne/_fiff/meas_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down