vincent-maillou / qttools

Quantum Transport Algorithms Toolbox
GNU General Public License v3.0
5 stars 1 forks source link

Documentation #54

Open vetschn opened 2 weeks ago

vetschn commented 2 weeks ago
codecov-commenter commented 2 weeks ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 93.00000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 85.18%. Comparing base (3fac381) to head (236afb7).

Files with missing lines Patch % Lines
src/qttools/__init__.py 72.72% 3 Missing :warning:
src/qttools/utils/mpi_utils.py 60.00% 2 Missing :warning:
src/qttools/utils/stack_utils.py 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #54 +/- ## ========================================== + Coverage 84.80% 85.18% +0.38% ========================================== Files 29 29 Lines 1198 1195 -3 ========================================== + Hits 1016 1018 +2 + Misses 182 177 -5 ```

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

vetschn commented 2 weeks ago

I construct a TypeAlias for NDArray in the top-level __init__.py now and switched all the method signatures to be using that instead of xp.ndarray (which is actually not even a proper TypeAlias). I'll check the consistency with the docstrings next.