docs(segment): added **kwargs in docstrings - #693
Open
AgarwalNilay wants to merge 2 commits into
Open
Conversation
…rface init_subject's **kwargs (forwarded to freesurfer.autorecon, plus the deprecated run_all alias) and cut_surface's **kwargs (forwarded to freesurfer.flatten or flatten_slim depending on flatten_with) were both undocumented. Adds indented **kwargs entries listing each forwarded argument individually. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
AgarwalNilay
force-pushed
the
docs/segment-docstrings
branch
from
August 24, 2026 16:37
32d433b to
cf3169d
Compare
kroq-gar78
requested changes
Aug 25, 2026
Address review feedback: rather than restating forwarded kwargs in init_subject/cut_surface (which duplicates docs across files and lets them drift), point at the function that owns them and document each parameter once, where it's actually defined: - autorecon(): add parallel, n_cores (were documented nowhere). - flatten_slim(): add n_iterations, do_flatten (were documented nowhere). - init_subject/cut_surface: condense **kwargs to a pointer plus a hint at the useful ones. save_every and slim_path already had docs in freesurfer.flatten() and flatten_slim() respectively, so the pointers now resolve for every forwarded kwarg. Co-Authored-By: Claude Opus 5 (1M context) <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
5 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.
init_subject's **kwargs (forwarded to freesurfer.autorecon, plus the deprecated run_all alias) and cut_surface's **kwargs (forwarded to freesurfer.flatten or flatten_slim depending on flatten_with) were both undocumented. Adds indented **kwargs entries listing each forwarded argument individually.