Skip to content

DOC: Add crossrefs to info docstring #13811

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

Open
athishdresu wants to merge 10 commits into
base: main
Choose a base branch
from
+18 −0
Open

DOC: Add crossrefs to info docstring #13811

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
373b070
DOC: Add crossrefs to info docstring
athishdresu Apr 3, 2026
1378433
MAINT: Add news fragment for PR 13811
athishdresu Apr 3, 2026
57b3fdf
DOC: Add Epochs proj methods and fix news fragment extension
athishdresu Apr 15, 2026
e5df212
DOC: Add missing Epochs proj methods
athishdresu Apr 28, 2026
a515bc6
DOC: Fix sphinx syntax in news fragment
athishdresu Apr 29, 2026
9c193d7
DOC: Add rename_channels to info docstring
athishdresu Jun 11, 2026
0ad295f
Merge branch 'main' into info-crossrefs
athishdresu Jun 11, 2026
6750a3c
DOC: Fix Sphinx indentation and blank line error
athishdresu Jun 11, 2026
598a101
Merge remote updates with local doc fix
athishdresu Jun 11, 2026
7cf9a4b
MAINT: Add contributor name to changelog
athishdresu Jun 12, 2026
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.other.rst
View file
Open in desktop
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.

@larsoner larsoner Jun 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically a first/last here if doable

Suggested change
Added cross-references to common modification methods in :class:`mne.Info` docstring.
Added cross-references to common modification methods in :class:`mne.Info` docstring by :newcontrib:`Athish M`.

And then a corresponding entry in doc/changes/names.inc

16 changes: 16 additions & 0 deletions mne/_fiff/meas_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading