[DOC] update kwargs/methods in docs#145
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.
|
|
||
| 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 |
There was a problem hiding this comment.
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 |
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
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.
No description provided.