Skip to content
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

MAINT: Add mne.surface to docstring tests #7930

Merged
merged 1 commit into from
Jun 25, 2020
Merged

MAINT: Add mne.surface to docstring tests #7930

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions doc/python_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,7 @@ Forward Modeling
setup_source_space
setup_volume_source_space
surface.complete_surface_info
surface.read_curvature
use_coil_def
write_bem_surfaces
write_trans
Expand Down
7 changes: 3 additions & 4 deletions mne/surface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,16 +626,15 @@ def read_curvature(filepath, binary=True):

Parameters
----------
filepath: str
filepath : str
Input path to the .curv file.
binary: bool
binary : bool
Specify if the output array is to hold binary values. Defaults to True.

Returns
-------
curv: array, shape=(n_vertices,)
curv : array, shape=(n_vertices,)
The curvature values loaded from the user given file.

"""
with open(filepath, "rb") as fobj:
magic = _fread3(fobj)
Expand Down
1 change: 1 addition & 0 deletions mne/tests/test_docstring_parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
'mne.simulation',
'mne.source_estimate',
'mne.source_space',
'mne.surface',
'mne.stats',
'mne.time_frequency',
'mne.time_frequency.tfr',
Expand Down