Update some docstrings

rerun-io · Oct 11, 2024 · fab4a9d · fab4a9d
1 parent 0d82240
commit fab4a9d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/crates/store/re_chunk_store/src/dataframe.rs b/crates/store/re_chunk_store/src/dataframe.rs
@@ -422,6 +422,9 @@ pub struct ComponentColumnSelector {
     pub entity_path: EntityPath,
 
     /// Semantic name associated with this data.
+    ///
+    /// This string will be flexibly matched against the available component names.
+    /// Valid matches are case invariant matches of either the full name or the short name.
     pub component_name: String,
 
     /// How to join the data into the `RecordBatch`.

diff --git a/crates/store/re_types_core/src/loggable.rs b/crates/store/re_types_core/src/loggable.rs
@@ -185,6 +185,9 @@ impl ComponentName {
         }
     }
 
+    /// Determine if component matches a string
+    ///
+    /// Valid matches are case invariant matches of either the full name or the short name.
     pub fn matches(&self, other: &str) -> bool {
         self.0.as_str() == other
             || self.full_name().to_lowercase() == other.to_lowercase()