Skip to content

Commit 73f60ce

Browse files
committed
DOC: add warning to save DigMontage: ch_names are not saved
1 parent ec77e7c commit 73f60ce

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

mne/channels/montage.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,16 @@ def save(self, fname, *, overwrite=False, verbose=None):
409409
The filename to use. Should end in .fif or .fif.gz.
410410
%(overwrite)s
411411
%(verbose)s
412+
413+
See Also
414+
--------
415+
read_dig_fif
416+
417+
Notes
418+
-----
419+
.. warning:: The channel names will **not** be saved, so
420+
when reading back via :func:`mne.channels.read_dig_fif`,
421+
new channel names will be made up on the spot.
412422
"""
413423
coord_frame = _check_get_coord_frame(self.dig)
414424
write_dig(fname, self.dig, coord_frame, overwrite=overwrite)
@@ -809,9 +819,9 @@ def read_dig_dat(fname):
809819

810820

811821
def read_dig_fif(fname):
812-
r"""Read digitized points from a .fif file.
822+
r"""Read digitized points from a FIF file.
813823
814-
Note that electrode names are not present in the .fif file so
824+
Note that electrode names are not present in the FIF file so
815825
they are here defined with the convention from VectorView
816826
systems (EEG001, EEG002, etc.)
817827

0 commit comments

Comments
 (0)