ert
ert copied to clipboard
Document storage
Issue Resolves #6737
Approach Short description of the approach
(Screenshot of new behavior in GUI if applicable)
- [x] PR title captures the intent of the changes, and is fitting for release notes.
- [ ] Added appropriate release note label
- [x] Commit history is consistent and clean, in line with the contribution guidelines.
- [ ] Make sure tests pass locally (after every commit!)
When applicable
- [ ] When there are user facing changes: Updated documentation
- [ ] New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
- [ ] Large PR: Prepare changes in small commits for more convenient review
- [ ] Bug fix: Add regression test for the bug
- [ ] Bug fix: Create Backport PR to latest release
Codecov Report
Attention: Patch coverage is 92.30769%
with 1 lines
in your changes are missing coverage. Please review.
Project coverage is 85.18%. Comparing base (
64fe249
) to head (28daca6
). Report is 83 commits behind head on main.
Files | Patch % | Lines |
---|---|---|
src/ert/storage/local_storage.py | 92.30% | 1 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## main #7254 +/- ##
==========================================
+ Coverage 84.52% 85.18% +0.65%
==========================================
Files 387 383 -4
Lines 23080 23305 +225
Branches 875 891 +16
==========================================
+ Hits 19509 19852 +343
+ Misses 3457 3344 -113
+ Partials 114 109 -5
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Did you look into the scikit learn documentation for example? It has some good examples of developer documentation, for example: https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/init.py and https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/metrics/_ranking.py