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
|
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
|
Same fix applied to |
effigies
added a commit
that referenced
this pull request
Aug 29, 2025
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.
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.