docs(segment): added **kwargs in docstrings - #693
Open
AgarwalNilay wants to merge 1 commit 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
| Additional keyword arguments are forwarded to | ||
| `cortex.freesurfer.autorecon`. The deprecated `run_all` kwarg is | ||
| also accepted as an alias for `do_import_subject`. | ||
|
|
Contributor
There was a problem hiding this comment.
Don't mention deprecated args in the docstring
| n_cores : int, optional | ||
| Number of cores to use for parallelization, if `parallel` is | ||
| True. Defaults to all available CPU cores. | ||
| """ |
Contributor
There was a problem hiding this comment.
Honestly I'd rather the original docstring for parallel and n_cores, since it avoids duplicating documentation across files.
Comment on lines
+209
to
+224
| save_every : int, optional | ||
| Only used when `flatten_with` is 'freesurfer'. If not None, saves | ||
| a version of the mesh every `save_every` iterations of the | ||
| flattening process (via `freesurfer.flatten`). Useful for | ||
| determining why a flattening fails. | ||
| n_iterations : int, optional | ||
| Only used when `flatten_with` is 'SLIM'. Number of iterations for | ||
| the SLIM flattening algorithm. Default is 20. | ||
| slim_path : str, optional | ||
| Only used when `flatten_with` is 'SLIM'. Path to the SLIM | ||
| executable. Defaults to the path specified in the pycortex | ||
| config file. | ||
| do_flatten : bool, optional | ||
| Only used when `flatten_with` is 'SLIM'. Whether to proceed with | ||
| flattening. If None (default), prompts for confirmation | ||
| interactively. |
Contributor
There was a problem hiding this comment.
Like before, condense this to avoid duplicating docstrings.
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.
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.