Add type hints - beef up docstrings - test examples, etc.#72
Add type hints - beef up docstrings - test examples, etc.#72jGaboardi wants to merge 13 commits intocarsonfarmer:mainfrom
Conversation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #72 +/- ##
=======================================
Coverage 100.0% 100.0%
=======================================
Files 2 3 +1
Lines 125 154 +29
=======================================
+ Hits 125 154 +29
|
There was a problem hiding this comment.
While I do think think that all the declared typing in L16-52 is verbose, it was a great way to learn the data structure better and has already helped with identifying ways to potentially improve the codebase (#69). If we are on the fence at all about keeping them, I'm in very favor of it.
Also, maybe we want to plop them into another file, e.g. fp_typing.py or something?
There was a problem hiding this comment.
@gegen07 -> typing broken out in types.py
This turned into a rather PR and I can split for ease of review, if desired.
__repr__()toFastPair#67mypy#70typing.Selfonly available in Python 3.11+ #73pytest-doctestplusfor doctest-only option #74cc @gegen07