search

kr8s-org / kr8s

A batteries-included Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl
https://kr8s.org
BSD 3-Clause "New" or "Revised" License
839 stars 45 forks source link

Rename async utilities and add more docstrings #388

Closed jacobtomlinson closed 5 months ago

jacobtomlinson commented 5 months ago

In #85 the private async utility code got renamed from _asyncio to _io as a reaction to adding trio support. However that name leaves a lot to be desired, so this PR renames it again to _async_utils to try and more clearly describe what it does.

I also took the opportunity to add a bunch more docstrings to try and make it clearer what the module does and the reasoning behind it.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.23%. Comparing base (87063fc) to head (b754300). Report is 101 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #388 +/- ## ========================================== + Coverage 94.61% 95.23% +0.61% ========================================== Files 29 29 Lines 3141 3418 +277 ========================================== + Hits 2972 3255 +283 + Misses 169 163 -6 ```

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