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

Type annotate the temporal module #604

Open
wants to merge 1 commit into
base: typecheck-apiformatting
Choose a base branch
from

Conversation

mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Sep 10, 2024

Important

To be merged only after merging #598 and then rebasing

Annotating this module was pretty quick! No typeguards or ignores needed.

Copy link

github-actions bot commented Sep 10, 2024

Binder 👈 Launch a binder notebook on this branch for commit 7f92261

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit e805f01

Binder 👈 Launch a binder notebook on this branch for commit 7b57037

@mfisher87 mfisher87 added the review::quick This change should not require more than 10 minutes to review label Sep 10, 2024
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.48%. Comparing base (3da94ef) to head (7b57037).

Additional details and impacted files
@@                     Coverage Diff                     @@
##           typecheck-apiformatting     #604      +/-   ##
===========================================================
+ Coverage                    65.44%   65.48%   +0.04%     
===========================================================
  Files                           38       38              
  Lines                         3128     3132       +4     
  Branches                       601      601              
===========================================================
+ Hits                          2047     2051       +4     
  Misses                         990      990              
  Partials                        91       91              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines -157 to -158
start_time: string, datetime.time, None
end_time: string, datetime.time, None
Copy link
Member

Choose a reason for hiding this comment

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

Why remove the start_time and end_time parameters? Shouldn't we just remove the type?

Copy link
Member Author

Choose a reason for hiding this comment

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

Since they're part of the function signature, they will be documented automatically; we only need to mention things in the docstring that aren't already represented in the function signature. One less thing to keep in sync :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review::quick This change should not require more than 10 minutes to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants