Skip to content
Merged
Changes from all 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
15 changes: 10 additions & 5 deletions mne/io/meas_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,14 +184,19 @@ class Info(dict, MontageMixin):
"""Measurement information.

This data structure behaves like a dictionary. It contains all metadata
that is available for a recording.

This class should not be instantiated directly. To create a measurement
information strucure, use :func:`mne.create_info`.
that is available for a recording. However, its keys are restricted to
those provided by the
`FIF format specification <https://github.com/mne-tools/fiff-constants>`__,
so new entries should not be manually added.

The only entries that should be manually changed by the user are
``info['bads']`` and ``info['description']``. All other entries should
be considered read-only, or should be modified by functions or methods.
be considered read-only, though they can be modified by various MNE-Python
functions or methods (which have safeguards to ensure all fields remain in
sync).

This class should not be instantiated directly. To create a measurement
information strucure, use :func:`mne.create_info`.

Attributes
----------
Expand Down