Skip to content

Commit 2cdc4af

Browse files
sappelhofflarsoner
andauthored
doc: point to read_dipole (#13149)
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
1 parent ccaefd4 commit 2cdc4af

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

mne/_fiff/meas_info.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1324,6 +1324,7 @@ class Info(ValidatedDict, SetChannelsMixin, MontageMixin, ContainsMixin):
13241324
See Also
13251325
--------
13261326
mne.create_info
1327+
mne.pick_info
13271328
13281329
Notes
13291330
-----

mne/dipole.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,10 @@ def save(self, fname, overwrite=False, *, verbose=None):
162162
.. versionadded:: 0.20
163163
%(verbose)s
164164
165+
See Also
166+
--------
167+
read_dipole
168+
165169
Notes
166170
-----
167171
.. versionchanged:: 0.20
@@ -518,15 +522,19 @@ def ch_names(self):
518522

519523
@verbose
520524
def save(self, fname, verbose=None):
521-
"""Save dipole in a .fif file.
525+
"""Save dipole in FIF format.
522526
523527
Parameters
524528
----------
525529
fname : path-like
526-
The name of the .fif file. Must end with ``'.fif'`` or
527-
``'.fif.gz'`` to make it explicit that the file contains
530+
The name of the FIF file. Must end with ``'-dip.fif'`` or
531+
``'-dip.fif.gz'`` to make it explicit that the file contains
528532
dipole information in FIF format.
529533
%(verbose)s
534+
535+
See Also
536+
--------
537+
read_dipole
530538
"""
531539
check_fname(
532540
fname,
@@ -585,12 +593,12 @@ def plot(self, show=True, time_unit="s"):
585593
# IO
586594
@verbose
587595
def read_dipole(fname, verbose=None):
588-
"""Read ``.dip`` file from Neuromag/xfit or MNE.
596+
"""Read a dipole object from a file.
589597
590598
Parameters
591599
----------
592600
fname : path-like
593-
The name of the ``.dip`` or ``.fif`` file.
601+
The name of the ``.[b]dip`` or ``.fif[.gz]`` file.
594602
%(verbose)s
595603
596604
Returns

0 commit comments

Comments
 (0)