search

icesat2py / icepyx

Python tools for obtaining and working with ICESat-2 data
https://icepyx.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
219 stars 107 forks source link

Partially typecheck `APIformatting` module #598

Closed mfisher87 closed 2 months ago

mfisher87 commented 2 months ago

Add type annotations and some refactors to the APIformatting module.

github-actions[bot] commented 2 months ago

Binder :point_left: Launch a binder notebook on this branch for commit 79fccf16ff190f3e08303f43ca813901e48b6691

I will automatically update this comment whenever this PR is modified

Binder :point_left: Launch a binder notebook on this branch for commit ca3f5531c7688183700b0a4aacb2ab0a9977860f

Binder :point_left: Launch a binder notebook on this branch for commit 3da94efb5a1528508ab983b78ce32812aaf3d4d2

Binder :point_left: Launch a binder notebook on this branch for commit ea4a0c52db0423258a6c6f4dfb22a53c81f9bddd

Binder :point_left: Launch a binder notebook on this branch for commit b90a10e95ecb7694564fab50a56c854433bc8e5a

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 60.71429% with 11 lines in your changes missing coverage. Please review.

Project coverage is 65.47%. Comparing base (1606dd0) to head (b90a10e). Report is 1 commits behind head on development.

Files with missing lines Patch % Lines
icepyx/core/APIformatting.py 56.52% 5 Missing and 5 partials :warning:
icepyx/core/exceptions.py 80.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## development #598 +/- ## =============================================== - Coverage 65.66% 65.47% -0.19% =============================================== Files 38 38 Lines 3122 3134 +12 Branches 599 601 +2 =============================================== + Hits 2050 2052 +2 - Misses 984 991 +7 - Partials 88 91 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mfisher87 commented 2 months ago

Integration tests: https://github.com/icesat2py/icepyx/actions/runs/11041992788

mfisher87 commented 2 months ago

Not passing. #598 fixes bug introduced on development branch from my last-merged PR.

mfisher87 commented 2 months ago

In the interest of time, I'm going to merge this PR with failing integration tests, having tested the solution locally and gotten this branch to pass. This will simplify #616 into a one-step change and reduce the amount of review cycles. Apologies if this is objectionable! Please let me know if so and I will avoid a repeat in the future.