Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

jGaboardi
Copy link
Collaborator

@jGaboardi jGaboardi commented Jul 10, 2024

@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2024

⚠️ 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 ✅

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

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

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #72   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files           2        3    +1     
  Lines         125      154   +29     
=======================================
+ Hits          125      154   +29     
Files Coverage Δ
fastpair/base.py 100.0% <100.0%> (ø)
fastpair/types.py 100.0% <100.0%> (ø)

Copy link
Collaborator Author

@jGaboardi jGaboardi Jul 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to create another file to typing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gegen07 -> typing broken out in types.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants