Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Run doctest in CI for Python API examples #1783

Closed
wjones127 opened this issue Oct 30, 2023 · 0 comments · Fixed by #1840
Closed

Run doctest in CI for Python API examples #1783

wjones127 opened this issue Oct 30, 2023 · 0 comments · Fixed by #1840
Labels
binding/python Issues for the Python package ci enhancement New feature or request good first issue Good for newcomers
Milestone
python v0.14

Comments

@wjones127
Copy link
Collaborator

Description

I don't think our Python examples are being run in CI. We should add this to make sure they are validated on PRs. Pytest has support for it: https://docs.pytest.org/en/7.1.x/how-to/doctest.html

Use Case

Related Issue(s)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
binding/python Issues for the Python package ci enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
python v0.14
Development

Successfully merging a pull request may close this issue.

ci: run doctest in CI for Python API examples marijncv/delta-rs
2 participants
@wjones127 @ion-elgreco