Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 5, 2025
Merged

Update docstrings for TimeInt and TimeRangeBoundary #9191

merged 1 commit into from
Mar 5, 2025

Conversation

emilk
Copy link
Member

@emilk emilk commented Mar 5, 2025

@emilk emilk added 🐍 Python API Python logging API exclude from changelog PRs with this won't show up in CHANGELOG.md labels Mar 5, 2025
@emilk emilk mentioned this pull request Mar 5, 2025
Closed
11 tasks
@abey79 abey79 self-requested a review March 5, 2025 13:20
abey79
abey79 approved these changes Mar 5, 2025
View reviewed changes
Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

LGTM, but let's @overload all the things!

rerun_py/rerun_sdk/rerun/datatypes/time_int_ext.py
@@ -10,26 +10,31 @@ def __init__(self: Any, *, seq: int | None = None, seconds: float | None = None,
"""
Create a new instance of the TimeInt datatype.

Exactly one of `seq`, `seconds`, or `nanos` must be provided.
Copy link
Member

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.

Copy link
Member Author

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

rerun_py/rerun_sdk/rerun/datatypes/time_range_boundary_ext.py
@@ -76,35 +76,38 @@ def absolute(
"""
Boundary that is at an absolute time.

Exactly one of 'time', 'seq', 'seconds', or 'nanos' must be provided.
Copy link
Member

Choose a reason for hiding this comment

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

ditto. and on __init__ too.

@emilk emilk merged commit eeae158 into main Mar 5, 2025
39 of 41 checks passed
@emilk emilk deleted the emilk/python-time-api-touchups branch March 5, 2025 15:40
@abey79 abey79 mentioned this pull request Mar 5, 2025
Merged
abey79 added a commit that referenced this pull request Mar 6, 2025
@abey79
Add/cleanup some @overload (#9204)
ef85e28 
Title. Follow-up to #9191
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abey79 abey79 abey79 approved these changes

Assignees
No one assigned
Labels
exclude from changelog PRs with this won't show up in CHANGELOG.md 🐍 Python API Python logging API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@emilk @abey79