-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
FIX,VIZ: Update read_curvature #7289
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.
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
FIX,VIZ: Update read_curvature #7289
Conversation
mne/surface.py
Outdated
|
|
||
| def read_curvature(filepath): | ||
| def read_curvature(filepath, binary=True): | ||
| """Load in curavature values from the ?h.curv file.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am surprised there is no docstring in this funciton and CIs don't complain. Can you add it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not checked because mne.surface is not in the public_modules list in mne/tests/test_docstring_parameters.py list. @GuillaumeFavelier feel free to add it. You might then need to fix some docstrings and/or add entries to docstring_ignores
Codecov Report
@@ Coverage Diff @@
## master #7289 +/- ##
=======================================
Coverage 89.80% 89.80%
=======================================
Files 447 447
Lines 80572 80572
Branches 12873 12873
=======================================
Hits 72360 72360
Misses 5385 5385
Partials 2827 2827 |
agramfort
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides LGTM
| Input path to the .curv file. | ||
| binary: bool | ||
| Specify if the output array is to hold binary values. Defaults to True. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returns
is missing
mne/surface.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems beyond the scope of this PR, I noted it in #7162 |
|
Thanks @GuillaumeFavelier |
* Update read_curvature * Improve docstring * Fix docstring
* Update read_curvature * Improve docstring * Fix docstring
this PR fixes the
load_curvature()function of the_Brainobject.master