document TUID name shenaniganeries

rerun-io · Nov 15, 2024 · 2fccc54 · 2fccc54
1 parent a873365
commit 2fccc54
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/utils/re_tuid/src/lib.rs b/crates/utils/re_tuid/src/lib.rs
@@ -18,6 +18,9 @@ pub struct Tuid {
 }
 
 impl Tuid {
+    /// We give an actual name to [`Tuid`], and inject that name into the Arrow datatype extensions,
+    /// as a hack so that we can compactly format them when printing Arrow data to the terminal.
+    /// Check out `re_format_arrow` for context.
     pub const NAME: &'static str = "rerun.datatypes.TUID";
 
     /// Returns the total size of `self` on the heap, in bytes.