MAINT: Add mne.surface to docstring tests (mne-tools#7930)

larsoner · Jun 25, 2020 · c9064e7 · c9064e7
1 parent 969c7d8
commit c9064e7
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/doc/python_reference.rst b/doc/python_reference.rst
@@ -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

diff --git a/mne/surface.py b/mne/surface.py
@@ -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)

diff --git a/mne/tests/test_docstring_parameters.py b/mne/tests/test_docstring_parameters.py
@@ -36,6 +36,7 @@
     'mne.simulation',
     'mne.source_estimate',
     'mne.source_space',
+    'mne.surface',
     'mne.stats',
     'mne.time_frequency',
     'mne.time_frequency.tfr',