docs(freesurfer): backfill missing docstrings across the module - #687
Open
AgarwalNilay wants to merge 2 commits into
Open
docs(freesurfer): backfill missing docstrings across the module#687AgarwalNilay wants to merge 2 commits into
AgarwalNilay wants to merge 2 commits into
Conversation
Adds numpy-style docstrings (Parameters/Returns) to previously undocumented functions and methods, and Returns sections to functions that already had Parameters but no Returns. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
AgarwalNilay
force-pushed
the
docs/freesurfer-docstrings
branch
from
August 21, 2026 01:50
5aa2622 to
430020c
Compare
kroq-gar78
requested changes
Aug 21, 2026
Comment on lines
55
to
56
| elif type == "slim": | ||
| return os.path.join(base, "surf", hemi+".{name}_slim.obj") |
Contributor
There was a problem hiding this comment.
This should raise a ValueError if none of these match.
| If `type` is "patch", a per-vertex flag array (1 for interior | ||
| vertices, -1 for boundary/edge vertices, 0 for vertices not in the | ||
| patch). Otherwise, the curvature values for this surface/hemisphere, | ||
| as returned by `get_curv`. |
| Returns | ||
| ------- | ||
| None | ||
| Writes `fname` as a side effect; has no return value. |
…hs error handling Adds missing Parameters/Returns sections to several helper functions (_remove_disconnected_polys, _move_disconnect_points_to_zero, make_fiducial, write_surf, get_surf, _move_labels, _parse_labels, _read_sphere_reg). Also fixes get_paths to raise ValueError on an unrecognized `type` instead of returning it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds docstrings (Parameters/Returns) to previously undocumented functions and methods, and Returns sections to functions