Skip to content

docs(segment): added **kwargs in docstrings #693

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.

Sign up for GitHub

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

Open
AgarwalNilay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(segment): added **kwargs in docstrings #693

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions cortex/segment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,17 @@ def init_subject(subject, filenames, do_import_subject=False, **kwargs):
editing) into pycortex. False by default, since we recommend editing
(or at least inspecting) the brain mask and white matter segmentations
prior to importing into pycortex.
kwargs : keyword arguments passed to cortex.freesurfer.autorecon()
useful ones: parallel=True, n_cores=4 (or more, if you have them)
**kwargs
Additional keyword arguments are forwarded to
`cortex.freesurfer.autorecon`. The deprecated `run_all` kwarg is
also accepted as an alias for `do_import_subject`.

@kroq-gar78 kroq-gar78 Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't mention deprecated args in the docstring

parallel : bool, optional
Whether to run autorecon-all in parallel (only applies to the
'2', 'wm', or 'all' autorecon steps). Default True.
n_cores : int, optional
Number of cores to use for parallelization, if `parallel` is
True. Defaults to all available CPU cores.
"""

@kroq-gar78 kroq-gar78 Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I'd rather the original docstring for parallel and n_cores, since it avoids duplicating documentation across files.

if "run_all" in kwargs:
warnings.warn(
Expand Down Expand Up @@ -193,6 +202,26 @@ def cut_surface(
auto_overwrite : bool
Whether to overwrite existing flatmaps. If True, the flatmap will be
overwritten without asking for confirmation.
**kwargs
Additional keyword arguments are forwarded to the flattening backend
selected by `flatten_with`:

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.
Comment on lines +209 to +224

@kroq-gar78 kroq-gar78 Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like before, condense this to avoid duplicating docstrings.

"""

if fs_subject is None:
Expand Down