-
Notifications
You must be signed in to change notification settings - Fork 484
Update docstrings for TimeInt
and TimeRangeBoundary
#9191
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -76,35 +76,38 @@ def absolute( | |
""" | ||
Boundary that is at an absolute time. | ||
|
||
Exactly one of 'time', 'seq', 'seconds', or 'nanos' must be provided. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ditto. and on |
||
|
||
Parameters | ||
---------- | ||
time: | ||
Absolute time. | ||
|
||
Mutually exclusive with seq, seconds and nanos. | ||
seq: | ||
Absolute time in sequence numbers. | ||
|
||
Use this for sequence timelines. | ||
Mutually exclusive with time, seconds and nanos. | ||
Not compatible with temporal timelines. | ||
|
||
seconds: | ||
Absolute time in seconds. | ||
|
||
Use this for time based timelines. | ||
Mutually exclusive with time, seq and nanos. | ||
Interpreted either as a duration or time since unix epoch (depending on timeline type). | ||
Not compatible with sequence timelines. | ||
|
||
nanos: | ||
Absolute time in nanoseconds. | ||
|
||
Use this for time based timelines. | ||
Mutually exclusive with time, seq and seconds. | ||
Interpreted either as a duration or time since unix epoch (depending on timeline type). | ||
Not compatible with sequence timelines. | ||
|
||
""" | ||
|
||
if sum(x is not None for x in (time, seq, seconds, nanos)) != 1: | ||
raise ValueError("Exactly one of 'time', 'seq', 'seconds', or 'nanos' must be provided.") | ||
|
||
from .time_range_boundary import TimeRangeBoundary | ||
|
||
if time is None: | ||
time = TimeInt(seq=seq, seconds=seconds, nanos=nanos) | ||
elif seq is not None or seconds is not None or nanos is not None: | ||
raise ValueError("Only one of time, seq, seconds, or nanos can be provided.") | ||
|
||
return TimeRangeBoundary(inner=time, kind="absolute") |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should be able to roll the
@overload
stuff on__init__
here too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather not take the time to do that now. That's an orthogonal improvement