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.

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

docs: use doctest to test README examples #135

Merged
merged 3 commits into from
Dec 18, 2023
Merged

docs: use doctest to test README examples #135

merged 3 commits into from
Dec 18, 2023

Conversation

nicrie
Copy link
Contributor

@nicrie nicrie commented Dec 16, 2023

Instead of using simple code snippets in README use doctest to ensure that shown examples are actually working (part of #130)

@nicrie nicrie marked this pull request as ready for review December 18, 2023 21:34
@codecov-commenter
Copy link

Codecov Report

Attention: 66 lines in your changes are missing coverage. Please review.

Comparison is base (0f95d04) 94.21% compared to head (275dd45) 94.39%.
Report is 61 commits behind head on main.

Files Patch % Lines
xeofs/utils/numba_utils.py 20.96% 49 Missing ⚠️
xeofs/data_container/data_container.py 88.88% 3 Missing ⚠️
xeofs/preprocessing/stacker.py 72.72% 3 Missing ⚠️
xeofs/models/_base_cross_model.py 96.07% 2 Missing ⚠️
xeofs/models/_base_model.py 96.07% 2 Missing ⚠️
xeofs/models/decomposer.py 86.66% 2 Missing ⚠️
xeofs/preprocessing/preprocessor.py 88.88% 2 Missing ⚠️
xeofs/utils/xarray_utils.py 88.88% 2 Missing ⚠️
xeofs/utils/io.py 97.95% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
+ Coverage   94.21%   94.39%   +0.17%     
==========================================
  Files          71       73       +2     
  Lines        5823     6152     +329     
==========================================
+ Hits         5486     5807     +321     
- Misses        337      345       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nicrie nicrie merged commit 382f6c7 into main Dec 18, 2023
6 of 7 checks passed
@nicrie nicrie deleted the doctest-readme branch December 19, 2023 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants