docs

spiraldb · Feb 26, 2025 · b875888 · b875888
1 parent 7a55fd9
commit b875888
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/encodings/runend/src/compute/take_from.rs b/encodings/runend/src/compute/take_from.rs
@@ -6,6 +6,18 @@ use vortex_error::VortexResult;
 use crate::{RunEndArray, RunEndEncoding};
 
 impl TakeFromFn<&RunEndArray> for RunEndEncoding {
+    /// Takes values from the source array using run-end encoded indices.
+    ///
+    /// # Arguments
+    ///
+    /// * `indices` - The run-end encoded array containing the indices
+    /// * `array` - The source array to take values from
+    ///
+    /// # Returns
+    ///
+    /// * `Ok(Some(array))` - If was successful
+    /// * `Ok(None)` - If the source array has an unsupported dtype
+    ///
     fn take_from(
         &self,
         indices: &RunEndArray,