#789 doctest to codecov#906
Open
kennethshsu wants to merge 11 commits into
Open
Conversation
kennethshsu
requested review from
genedan,
henrydingliu and
jbogaardt
as code owners
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 2ea3c64. Configure here.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #906 +/- ##
==========================================
+ Coverage 86.92% 88.12% +1.19%
==========================================
Files 87 87
Lines 4942 4942
Branches 625 625
==========================================
+ Hits 4296 4355 +59
+ Misses 456 445 -11
+ Partials 190 142 -48
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
Author
|
This is cool, we got +1.19% from doctests coverage. |
Collaborator
Author
|
A bit more info where the increase is from: 2 lines covered by doctests not already covered by pytests:
|
Docs-only; no runtime, config, or public API changes. Clean-up Deletes the 36 .rst stub files under docs/library/generated/. Adds docs/library/generated/ to .gitignore, mirroring the existing docs/modules/generated/ entry one line above. These files are emitted by sphinx.ext.autosummary on every docs build (autosummary_generate = True in docs/conf.py, driven by the eight :toctree: generated/ directives in docs/library/api.md), so committing them is redundant and the committed copies drift out of sync with what Sphinx actually produces. Adds custom sphinx.ext.autosummary templates under docs/_templates/autosummary/: class.rst, class_inherited.rst, function.rst. API class pages now list own methods inline, and inherited methods in a summary table (via Jinja logic in the templates) Fixes the :template: names in docs/library/api.md to drop .rst (:template: class.rst → :template: class). Sets numpydoc_show_class_members = False and templates_path = ['_templates'] in docs/_config.yml (and the generated docs/conf.py). Guards docs/_ext/linkcode.py against property objects so inline members don't crash the build. properties since removed. will keep this redundancy in place Misc docstring bug fixes, from doctest warnings
Collaborator
Author
|
@henrydingliu did you mean to push to this branch? |
…nto #789_doctest_to_codecov
Collaborator
Author
|
Ahh I think I see you basically pulled from main. |
Collaborator
Author
|
@genedan you'll need to review this one now lol... |
henrydingliu
approved these changes
Jun 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary of Changes
Added doctest's result to codecov
Related GitHub Issue(s)
Closes #789
Additional Context for Reviewers
In addition to the above, I also added
docs/library/generated/to.gitignoreto silence the untracked files that were generated, but also to untracked all generated files properly.uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)Note
Low Risk
Changes are limited to CI, coverage reporting, and dependency lock metadata with no production runtime behavior changes.
Overview
CI now collects doctest coverage and uploads it to Codecov: the doctest job runs the Jupyter Book doctest build under
coverage run(separateCOVERAGE_FILE), emitscoverage-doctest.xml, and adds a Codecov upload step. The main unit-test matrix installs--extra docsalongside test extras so doc-related deps align with that workflow.Housekeeping adds
coverage-doctest.xmlto.gitignoreand refreshesuv.lock(drops a directnumbadependency on the package, tightens the declared numpy constraint to>=2.0).Reviewed by Cursor Bugbot for commit dbc9b0e. Bugbot is set up for automated code reviews on this repo. Configure here.