Skip to content

Conversation

@machow
Copy link
Owner

@machow machow commented Dec 5, 2025

Addresses #389 and #390 by simplifying table output for Returns, Raises, and Yields if their results are not given a name. E.g. the example below would

produces a table with type and description

"""
...

Raises
------
LinAlgException
    If the matrix is not numerically invertible.
"""

produces a table with name, type, and description

"""
...

Raises
------
some_err: LinAlgException
    If the matrix is not numerically invertible.
"""

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.53%. Comparing base (8d8252f) to head (a4025b4).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #416      +/-   ##
==========================================
+ Coverage   89.25%   89.53%   +0.28%     
==========================================
  Files          40       40              
  Lines        3163     3183      +20     
==========================================
+ Hits         2823     2850      +27     
+ Misses        340      333       -7     

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

@machow
Copy link
Owner Author

machow commented Dec 5, 2025

Rendered the snapshot in quarto and it LGTM!

Note that the returns isn't shortened, since I think they all have to not have a name in order to simplify the result

image

@machow machow marked this pull request as ready for review December 5, 2025 22:00
@machow machow merged commit 1fc3fbd into main Dec 5, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this to Done in quartodoc Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants