Skip to content

Commit 1652a7c

Browse files
authored
DOC: fix docstrs around layout functions (#13300)
1 parent b78d661 commit 1652a7c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

mne/channels/layout.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def save(self, fname, overwrite=False):
8282
Parameters
8383
----------
8484
fname : path-like
85-
The file name (e.g. ``'my_layout.lout'``).
85+
The file name (must end with either ``.lout`` or ``.lay``).
8686
overwrite : bool
8787
If True, overwrites the destination file if it exists.
8888
@@ -306,7 +306,7 @@ def read_layout(fname=None, *, scale=True):
306306
----------
307307
fname : path-like | str
308308
Either the path to a ``.lout`` or ``.lay`` file or the name of a
309-
built-in layout. c.f. Notes for a list of the available built-in
309+
built-in layout. See Notes for a list of the available built-in
310310
layouts.
311311
scale : bool
312312
Apply useful scaling for out the box plotting using ``layout.pos``.
@@ -405,7 +405,7 @@ def read_layout(fname=None, *, scale=True):
405405
def make_eeg_layout(
406406
info, radius=0.5, width=None, height=None, exclude="bads", csd=False
407407
):
408-
"""Create .lout file from EEG electrode digitization.
408+
"""Make a Layout object based on EEG electrode digitization.
409409
410410
Parameters
411411
----------
@@ -486,7 +486,9 @@ def make_eeg_layout(
486486

487487
@fill_doc
488488
def make_grid_layout(info, picks=None, n_col=None):
489-
"""Generate .lout file for custom data, i.e., ICA sources.
489+
"""Make a grid Layout object.
490+
491+
This can be helpful to plot custom data such as ICA sources.
490492
491493
Parameters
492494
----------

0 commit comments

Comments
 (0)