at least a courteous reminder

rerun-io · Oct 7, 2024 · 7714d7b · 7714d7b
1 parent 00d472a
commit 7714d7b
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/crates/store/re_chunk/src/chunk.rs b/crates/store/re_chunk/src/chunk.rs
@@ -116,7 +116,11 @@ impl PartialEq for Chunk {
 }
 
 impl Chunk {
-    /// Returns a version of us with a new id
+    /// Returns a version of us with a new [`ChunkId`].
+    ///
+    /// Reminder:
+    /// * The returned [`Chunk`] will re-use the exact same [`RowId`]s as `self`.
+    /// * Duplicated [`RowId`]s in the `ChunkStore` is undefined behavior.
     #[must_use]
     #[inline]
     pub fn with_id(mut self, id: ChunkId) -> Self {