-
Notifications
You must be signed in to change notification settings - Fork 14
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.
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
Fix code snippets in documentation for doctest #1440
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main-dev #1440 +/- ##
============================================
- Coverage 78.49% 78.33% -0.17%
============================================
Files 140 140
Lines 21299 21413 +114
============================================
+ Hits 16719 16773 +54
- Misses 4580 4640 +60
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Once #1439 fixed, this should be easier, but still a pretty big task |
b1d9b2d
to
2342767
Compare
2342767
to
db7a393
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Change Summary
Adds support for doctest and ensures all doctests pass locally. Note that since the doctests examples rely on lustre data, they have not been enabled for the CI testing.
To run doctest when running tests locally add --doctest-modules to your pytest invocation (ie.
pytest --doctest-modules
)To have every pytest run use this option automatically, create a
pytest.ini
with the following content:Related issue number
closes #1438
Checklist