mention atty shenanigans + format

rerun-io · Dec 13, 2023 · ccadb17 · ccadb17
1 parent b60bc19
commit ccadb17
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/examples/python/stdio/main.py b/examples/python/stdio/main.py
@@ -1,8 +1,5 @@
 #!/usr/bin/env python3
-"""
-Demonstrates how to log data to standard output with the Rerun SDK, and then visualize it
-from standard input with the Rerun Viewer.
-"""
+"""Demonstrates how to use standard input/output with the Rerun SDK/Viewer."""
 from __future__ import annotations
 
 import sys
@@ -17,4 +14,4 @@
 
 input = sys.stdin.buffer.read()
 
-rr.log("stdin", rr.TextDocument(input.decode('utf-8')))
+rr.log("stdin", rr.TextDocument(input.decode("utf-8")))
diff --git a/rerun_py/rerun_sdk/rerun/sinks.py b/rerun_py/rerun_sdk/rerun/sinks.py
@@ -76,6 +76,9 @@ def stdout(recording: RecordingStream | None = None) -> None:
 
     Call this _before_ you log any data!
 
+    If there isn't any listener at the other end of the pipe, the `RecordingStream` will
+    default back to `buffered` mode, in order not to break the user's terminal.
+
     Parameters
     ----------
     recording: