Give proper attribution for ZipValidity

rerun-io · Dec 18, 2024 · f84e718 · f84e718
1 parent b329d4a
commit f84e718
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/crates/store/re_types_core/src/arrow_zip_validity.rs b/crates/store/re_types_core/src/arrow_zip_validity.rs
@@ -1,5 +1,10 @@
-//! Code adapted from <https://github.com/jorgecarleitao/arrow2/blob/main/src/bitmap/utils/zip_validity.rs>
-// TODO: rename and maybe rewrite
+//! Easily iterate over arrow values that may contain nulls.
+//!
+//! Code adapted from <https://github.com/jorgecarleitao/arrow2/blob/65c0ac4182748ec39b0a158ec5ebde829aae12b6/src/bitmap/utils/zip_validity.rs>
+//! Originally written by [Jorge Leitao](https://github.com/jorgecarleitao),
+//! under Apache License 2.0 (see `LICENSE-APACHE` file).
+//!
+//! Adapted by Rerun to work with `arrow` crate.
 
 use arrow::{buffer::NullBuffer, util::bit_iterator::BitIterator};
 
@@ -95,6 +100,7 @@ where
 {
     /// There are no null values
     Required(I),
+
     /// There are null values
     Optional(ZipValidityIter<T, I, V>),
 }