Skip to content

Conversation

@tsalo
Copy link
Member

@tsalo tsalo commented Nov 24, 2025

Closes #328.

Changes proposed in this pull request

  • On each model page, add a section called " in QSIRecon" with information on relevant actions and links to API documentation for relevant workflows and classes.

@tsalo tsalo added the documentation Improvements or additions to documentation label Nov 24, 2025
@tsalo
Copy link
Member Author

tsalo commented Nov 24, 2025

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 12.59%. Comparing base (210ee03) to head (7e04387).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #330   +/-   ##
=======================================
  Coverage   12.59%   12.59%           
=======================================
  Files          56       56           
  Lines        8156     8156           
  Branches     1123     1123           
=======================================
  Hits         1027     1027           
  Misses       7097     7097           
  Partials       32       32           

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

Comment on lines -207 to -208
# Avoid duplicate/invalid module references from package docstring
"workflows/recon/__init__.py",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed in order to have API docs for qsirecon.workflows.recon.

@tsalo tsalo marked this pull request as ready for review December 1, 2025 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add information about recon specs, actions, and interfaces to model pages

3 participants