DOC: Fix non-standard Input/Output docstring section management #3505
Conversation
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
Contributor
Author
|
Have not tested locally. |
jhlegarreta
added a commit
to jhlegarreta/fmriprep
that referenced
this pull request
Aug 20, 2025
Add myself to contributor list after: nipreps#3504 nipreps#3505
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3505 +/- ##
=======================================
Coverage 73.56% 73.56%
=======================================
Files 60 60
Lines 4600 4600
Branches 585 585
=======================================
Hits 3384 3384
- Misses 1087 1089 +2
+ Partials 129 127 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Fix non-standard Input/Output docstring section management: map `Inputs` and `Outputs` to `params_style` and `returns_style`, respectively, for `napoleon` custom sections (instead of mapping them to `Parameters`). Documentation: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_custom_sections
jhlegarreta
force-pushed
the
doc/fix-io-section-treatment
branch
from
bb65399 to
eebd67b
Compare
Contributor
Author
|
Same fix applied to |
effigies
added a commit
that referenced
this pull request
Aug 29, 2025
effigies
added a commit
that referenced
this pull request
Oct 1, 2025
25.2.0 (October 01, 2025) New feature release in the 25.2.x series. This release is an *fMRIPrep Long-Term Support (LTS)* release. The planned support window is 4 years, until October 2029. This release is an incremental improvement over 25.1.x, but includes some fixes and improvements that do not fit within our `bug-fix policy <https://www.nipreps.org/devs/releases/#bug-fix-releases>`__. Importantly, the change in interpolation in 25.1.0 introduced artifacts for some datasets. This release changes the default interpolation mode to ``grid-constant``, which resolves those problems while not reintroducing the issue the previous release sought to fix. This release also (finally) introduces per-session processing. The ``--session-label`` flag selects the sessions to process, and the ``--subject-anatomical-reference`` flag indicates whether and how to combine across sessions. Existing filters passed via ``--bids-filter-file`` may need to be updated or removed in favor of using these flags to achieve the desired behavior. We would like to thank the AMP-SCZ and ENIGMA consortia for testing out and providing feedback on this release. * FIX: Clean up output report language (#3529) * FIX: Default to grid-constant interpolation mode (#3516) * FIX: Adapt to transposed ndcoords in nitransforms (#3517) * FIX: Write out Freesurfer-derived outputs (#3512) * FIX: Add kwargs to _warnings.py (#3483) * ENH: Resample BOLD data to any surface template space using the Connectome Workbench (#3461) * ENH: Add boldref / sbref to source metadata (#3532) * ENH: Add dedicated session filtering, alternative anatomical template options (#3495) * ENH: Write out goodvoxels mask (#3513) * ENH: Add registration metadata to boldref-to-anat transforms (#3500) * ENH: Write out cortex mask GIFTIs (#3491) * ENH: Update transforms.py according to new transform chain of nitransforms (#3494) * RF/DOC: Improve and document command-line parser defaults (#3487) * DOC: Explain better SDC and B0FieldSource requirement (#2768) * DOC: Document `freesurfer` parameter in BOLD confound workflow init (#3504) * DOC: Add myself to contributor list (#3506) * DOC: Fix non-standard Input/Output docstring section management (#3505) * MNT: Split Dockerfile into base and pixi layers (#3521) * MNT: Replace conda with pixi and lock (#3503) * MNT: Update license metadata using SPDX expression (#3486) * MNT: no need to re-run `ruff check` after `ruff format` (#3480) * MNT: Update pre-commit ruff legacy alias (#3479)
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.
Changes proposed in this pull request
Fix non-standard Input/Output docstring section management: map
InputsandOutputstoparams_styleandreturns_style, respectively, fornapoleoncustom sections (instead of mapping them toParameters).Documentation:
https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_custom_sections
Documentation that should be reviewed
Any workflow function.