codecov[bot]
commented
4 years ago Codecov Report
Merging #27 into master will increase coverage by
0.82%. The diff coverage is33.33%.
@@ Coverage Diff @@
## master #27 +/- ##
==========================================
+ Coverage 66.07% 66.89% +0.82%
==========================================
Files 7 9 +2
Lines 280 287 +7
Branches 76 76
==========================================
+ Hits 185 192 +7
Misses 73 73
Partials 22 22 | Impacted Files | Coverage Δ | |
|---|---|---|
| src/xcape/__init__.py | 100.00% <ø> (ø) |
|
| src/xcape/_version.py | 100.00% <ø> (ø) |
|
| src/xcape/cape_numba.py | 50.00% <ø> (ø) |
|
| src/xcape/core.py | 84.31% <ø> (ø) |
|
| src/xcape/duck_array_ops.py | 79.31% <ø> (ø) |
|
| src/xcape/srh.py | 93.33% <ø> (ø) |
|
| src/xcape/stdheight.py | 62.50% <ø> (ø) |
|
| src/xcape/xarray.py | 0.00% <ø> (ø) |
|
| src/xcape/cape_fortran.py | 63.63% <33.33%> (ø) |
|
| ... and 1 more |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update ec5b6a7...f70056c. Read the comment docs.
Added documentation for CAPE and CIN calculation and associated wrapped functions. As a user will interact with calc_cape my feeling is that the specification and documentation is required at that point for clarity, with wrapper functions having documentation restricted to what is necessary for contributors.
Still need to:
Have formulas verified to ensure that they display appropriately in the created readthedocs.io and make sure they are correctly defined.
Add an appropriate reference for the formula version used.
Verify that all options are documented appropriately and that the procedure is appropriately specified.
Ensure that description is appropriate.