Skip to content

DOC: fix docstrs around layout functions #13300

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
Jun 26, 2025
Merged

DOC: fix docstrs around layout functions #13300

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
10 changes: 6 additions & 4 deletions mne/channels/layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def save(self, fname, overwrite=False):
Parameters
----------
fname : path-like
The file name (e.g. ``'my_layout.lout'``).
The file name (must end with either ``.lout`` or ``.lay``).
overwrite : bool
If True, overwrites the destination file if it exists.

Expand Down Expand Up @@ -306,7 +306,7 @@ def read_layout(fname=None, *, scale=True):
----------
fname : path-like | str
Either the path to a ``.lout`` or ``.lay`` file or the name of a
built-in layout. c.f. Notes for a list of the available built-in
built-in layout. See Notes for a list of the available built-in
layouts.
scale : bool
Apply useful scaling for out the box plotting using ``layout.pos``.
Expand Down Expand Up @@ -405,7 +405,7 @@ def read_layout(fname=None, *, scale=True):
def make_eeg_layout(
info, radius=0.5, width=None, height=None, exclude="bads", csd=False
):
"""Create .lout file from EEG electrode digitization.
"""Make a Layout object based on EEG electrode digitization.

Parameters
----------
Expand Down Expand Up @@ -486,7 +486,9 @@ def make_eeg_layout(

@fill_doc
def make_grid_layout(info, picks=None, n_col=None):
"""Generate .lout file for custom data, i.e., ICA sources.
"""Make a grid Layout object.

This can be helpful to plot custom data such as ICA sources.

Parameters
----------
Expand Down