[SDK] docs: clarify Streamer.put force parameter behavior

CPUat · CPUat · commit d45abc72c9e8 · 2026-06-20T22:40:23.000+08:00
diff --git a/sdks/python/src/opik/message_processing/streamer.py b/sdks/python/src/opik/message_processing/streamer.py
@@ -55,6 +55,12 @@ def put(self, message: messages.BaseMessage, force: bool = False) -> bool:
         Returns ``True`` if the message was accepted by the streamer (queued or
         consumed by a preprocessor). Returns ``False`` if the streamer is draining
         or if preprocessing failed, so callers that need durability can react.
+
+        Args:
+            message: The message to enqueue.
+            force: If ``True``, enqueue the message even while the streamer is
+                draining. This is used for internal replay paths that must run
+                during shutdown.
         """
         with self._lock:
             if self._drain and not force:
