Skip to content

Conversation

jhlegarreta
Copy link
Contributor

@jhlegarreta jhlegarreta commented Aug 20, 2025

Changes proposed in this pull request

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

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.

@jhlegarreta
Copy link
Contributor Author

Have not checked that this works.

Copy link

codecov bot commented Aug 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.73%. Comparing base (4311dcd) to head (dd7b67d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #105   +/-   ##
=======================================
  Coverage   78.73%   78.73%           
=======================================
  Files          80       80           
  Lines        5870     5870           
  Branches      591      591           
=======================================
  Hits         4622     4622           
  Misses       1094     1094           
  Partials      154      154           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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
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.

1 participant