-
Notifications
You must be signed in to change notification settings - Fork 539
Rename to tee
to set_sinks
#10312
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
Rename to tee
to set_sinks
#10312
Conversation
Web viewer built successfully. If applicable, you should also test it:
Note: This comment is updated whenever you push a commit. |
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.
change lgtm
but I suggested a few additions to the docstrings which is practically unrelated to this rename, but might as well put that into this pr 🤷 (at your discretion)
recording: RecordingStream | None = None, | ||
) -> None: | ||
""" | ||
Stream data to multiple different sinks. |
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.
here and on recording_stream
:
what happens to any data logged so far, will those new sinks catch up (I reckon no).
I think this is important to clarify.
the interaction of spawn=True
and attach_sinks
is also worth pointing out on rr.init
's documentation
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.
words are hard. it still seems a bit complicated but i've probably spent enough time trying to reword it, so i'll leave it as is in the latest commit and merge. the fact that it's not "easily" documentable suggests to me that what we have is overly complex, and we should head towards "first class sinks" as the only thing asap.
Changing the name discussed in #10158 (comment)
We also decided to add back the stateful API.