DOC: Fix non-standard Input/Output docstring section management #105
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
Inputs
andOutputs
toparams_style
andreturns_style
, respectively, fornapoleon
custom 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
Ideally, build locally to check it this makes the trick and check e.g. the confound computation documentation https://petprep.readthedocs.io/en/latest/api.html#calculate-pet-confounds.