Skip to content

Commit

Permalink
Update documentations in montage.py (mne-tools#7399)
Browse files Browse the repository at this point in the history
* Update montage.py

specify that head_size parameter expects a radius

* Update montage.py

adhere to style guidelines

* Update montage.py

remove trailing whitespace
  • Loading branch information
dominikwelke authored Mar 9, 2020
1 parent ff2442f commit 1cf95cc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions mne/channels/montage.py
Original file line number Diff line number Diff line change
Expand Up @@ -967,8 +967,8 @@ def read_custom_montage(fname, head_size=HEAD_SIZE_DEFAULT, coord_frame=None):
'.elc', '.txt', '.csd', '.elp' (BESA spherical),
'.bvef' (BrainVision files).
head_size : float | None
The size of the head in meters. If `None`, returns the values read from
the montage file with no modification. Defaults to 0.095m.
The size of the head (radius, in [m]). If ``None``, returns the values
read from the montage file with no modification. Defaults to 0.095m.
coord_frame : str | None
The coordinate frame of the points. Usually this is "unknown"
for native digitizer space. Defaults to None, which is "unknown" for
Expand Down Expand Up @@ -1142,7 +1142,7 @@ def make_standard_montage(kind, head_size=HEAD_SIZE_DEFAULT):
kind : str
The name of the montage to use. See notes for valid kinds.
head_size : float
The head size (in meters) to use for spherical montages.
The head size (radius, in meters) to use for spherical montages.
Defaults to 95mm.
Returns
Expand Down

0 comments on commit 1cf95cc

Please sign in to comment.