arup-group / genet

Manipulate MATSim networks via a Python API.
MIT License
45 stars 9 forks source link

Finish updating docstrings #232

Closed brynpickering closed 6 months ago

brynpickering commented 8 months ago

Updated docstrings I missed in #229 and added type hints to methods if they have an associated docstring. Now everything will render nicely in the docs :)

codecov-commenter commented 8 months ago

Codecov Report

Attention: Patch coverage is 97.29730% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 92.24%. Comparing base (dd88fb0) to head (74c3ab6).

Files Patch % Lines
genet/input/read.py 86.66% 1 Missing and 1 partial :warning:
genet/utils/plot.py 50.00% 0 Missing and 1 partial :warning:
genet/utils/secrets_vault.py 90.90% 0 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #232 +/- ## ========================================== + Coverage 92.19% 92.24% +0.04% ========================================== Files 37 37 Lines 6623 6639 +16 Branches 1590 1590 ========================================== + Hits 6106 6124 +18 Misses 298 298 + Partials 219 217 -2 ```

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

brynpickering commented 6 months ago

@KasiaKoz bump to avoid this going stale!