Skip to content

Clearer info docstring #7832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
larsoner merged 1 commit into from
May 26, 2020
Merged

Clearer info docstring #7832

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions mne/io/meas_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,14 @@ class Info(dict, MontageMixin):
`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, though they can be modified by various MNE-Python
functions or methods (which have safeguards to ensure all fields remain in
sync).
.. warning:: 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, 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`.
information structure, use :func:`mne.create_info`.

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