Docs/dataset docstrings - #688
Open
AgarwalNilay wants to merge 10 commits into
Open
Conversation
AgarwalNilay
force-pushed
the
docs/dataset-docstrings
branch
from
August 21, 2026 01:50
12159e1 to
728c76a
Compare
kroq-gar78
requested changes
Aug 23, 2026
| Returns | ||
| ------- | ||
| generator | ||
| Yields `self`. |
Contributor
There was a problem hiding this comment.
Suggested change
| Yields `self`. | |
| Yields `BrainData`. |
Comment on lines
650
to
652
Contributor
There was a problem hiding this comment.
Is this still true with the pure Python surf2surf implementation?
Spells out what actually flows through the previously-vague **kwargs line: state, priority, stim, rate, delay, filter, and (Volume2D/Vertex2D only) alpha. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The docstring claimed this calls cortex.freesurfer.vertex_to_vertex(), which no longer exists; the code actually calls db.get_mri_surf2surf_matrix(). Also adds the missing Returns section. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
These resolve as the actual inherited methods surfaced on the website for Volume/Vertex (.raw) and Volume2D/Vertex2D/VolumeRGB/VertexRGB (.copy/.from_hdf, unoverridden). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Both claimed kwargs must be BrainData or Dataset objects; normalize() actually also accepts tuples, filename strings, and dicts. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…erlay/uniques All were previously undocumented public methods. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…niques Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Docstring was a literal """TODO: WHAT IS THIS""" left by the original author; resolves as Volume.uniques/Vertex.uniques on the website. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- BrainData.uniques(): describe the yielded type (BrainData) rather than the self-specific implementation detail, per review suggestion. - Vertex.map(): update the stale "active freesurfer environment" NOTE. get_mri_surf2surf_matrix was rewritten as a pure-Python implementation (direct nnfr construction from sphere.reg files) that requires no mri_surf2surf binary call; reworded to reflect the actual requirement (sphere.reg files existing on disk, produced by a prior recon-all run). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
AgarwalNilay
force-pushed
the
docs/dataset-docstrings
branch
from
August 24, 2026 17:05
728c76a to
a2b050e
Compare
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.
docstrings for dataset functions