carsonfarmer / fastpair

FastPair: Data-structure for the dynamic closest-pair problem.
MIT License
12 stars 4 forks source link

Add type hints - beef up docstrings - test examples, etc. #72

Open jGaboardi opened 3 months ago

jGaboardi commented 3 months ago

This turned into a rather PR and I can split for ease of review, if desired.

cc @gegen07

codecov-commenter commented 3 months ago

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

Codecov Report

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

Project coverage is 100.0%. Comparing base (7df712d) to head (e6bec88).

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/carsonfarmer/fastpair/pull/72/graphs/tree.svg?width=650&height=150&src=pr&token=9VQNETZHJX&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Carson+Farmer)](https://app.codecov.io/gh/carsonfarmer/fastpair/pull/72?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Carson+Farmer) ```diff @@ Coverage Diff @@ ## main #72 +/- ## ======================================= Coverage 100.0% 100.0% ======================================= Files 2 3 +1 Lines 125 154 +29 ======================================= + Hits 125 154 +29 ``` | [Files](https://app.codecov.io/gh/carsonfarmer/fastpair/pull/72?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Carson+Farmer) | Coverage Δ | | |---|---|---| | [fastpair/base.py](https://app.codecov.io/gh/carsonfarmer/fastpair/pull/72?src=pr&el=tree&filepath=fastpair%2Fbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Carson+Farmer#diff-ZmFzdHBhaXIvYmFzZS5weQ==) | `100.0% <100.0%> (ø)` | | | [fastpair/types.py](https://app.codecov.io/gh/carsonfarmer/fastpair/pull/72?src=pr&el=tree&filepath=fastpair%2Ftypes.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Carson+Farmer#diff-ZmFzdHBhaXIvdHlwZXMucHk=) | `100.0% <100.0%> (ø)` | |