some more doc

rerun-io · Jul 7, 2023 · 9be3b31 · 9be3b31
1 parent c4900b1
commit 9be3b31
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/re_sdk/src/log_sink.rs b/crates/re_sdk/src/log_sink.rs
@@ -123,6 +123,8 @@ impl MemorySinkStorage {
     }
 
     /// Consumes and returns the inner array of [`LogMsg`].
+    ///
+    /// This automatically takes care of flushing the underlying [`crate::RecordingStream`].
     #[inline]
     pub fn take(&self) -> Vec<LogMsg> {
         if let Some(rec_stream) = self.rec_stream.as_ref() {