Skip to content

[DOC] update kwargs/methods in docs#145

Merged
36000 merged 2 commits into
tractometry:mainfrom
36000:update_docs
Jan 12, 2026
Merged

[DOC] update kwargs/methods in docs#145
36000 merged 2 commits into
tractometry:mainfrom
36000:update_docs

Conversation

@36000

@36000 36000 commented Jan 12, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings January 12, 2026 21:53

Copilot AI left a comment

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.

Pull request overview

This PR updates the documentation for kwargs and methods reference files to reflect recent changes in the codebase, including new parameters, reorganized sections, and updated descriptions.

Changes:

  • Added new STRUCTURAL section in kwargs.rst with brain_mask_definition parameter
  • Added new TISSUE section in kwargs.rst with PVE and MSMT-related parameters
  • Reorganized and updated method descriptions in methods.rst, including new entries for tissue segmentation models (synthseg_model, mx_model) and moved T1w-related parameters
  • Updated default values and descriptions for various parameters including ray_n_cpus, numba_n_threads, reg_subject_spec, and scalars

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File Description
docs/source/reference/methods.rst Reorganized parameter ordering, added new tissue segmentation and T1w parameters, removed deprecated MSMT and endpoint parameters from old locations and moved them to more logical positions
docs/source/reference/kwargs.rst Added STRUCTURAL and TISSUE sections, updated parameter descriptions to reflect current implementation, reorganized MSMT parameters into TISSUE section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/reference/methods.rst
Comment thread docs/source/reference/methods.rst
Comment thread docs/source/reference/methods.rst
Comment thread docs/source/reference/methods.rst
Comment thread docs/source/reference/methods.rst

virtual_frame_buffer: bool
Whether to use a virtual frame buffer. This is if generating GIFs in a headless environment. Default: False
Whether to use a virtual frame buffer. This is if generating GIFs in a headless environment. Default: False

Copilot AI Jan 12, 2026

Copy link

Choose a reason for hiding this comment

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

Missing space after "This is" - should be "This is useful if generating GIFs in a headless environment." The word "useful" appears to be missing from the description.

Suggested change
Whether to use a virtual frame buffer. This is if generating GIFs in a headless environment. Default: False
Whether to use a virtual frame buffer. This is useful if generating GIFs in a headless environment. Default: False

Copilot uses AI. Check for mistakes.
Comment thread docs/source/reference/kwargs.rst
Comment thread docs/source/reference/kwargs.rst
Comment thread docs/source/reference/methods.rst Outdated
Comment thread docs/source/reference/methods.rst
@36000
36000 merged commit 3296c9a into tractometry:main Jan 12, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants