docs

Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>

Author: connortsui20

vortex-vector/src/bool/vector_mut.rs

@@ -151,7 +151,7 @@ impl VectorMutOps for BoolVectorMut {
     }
 
     fn append_nulls(&mut self, n: usize) {
-        self.bits.append_n(false, n);
+        self.bits.append_n(false, n); // Note that the value we push doesn't actually matter.
         self.validity.append_n(false, n);
     }
 

vortex-vector/src/primitive/generic_mut.rs

@@ -184,7 +184,7 @@ impl<T: NativePType> VectorMutOps for PVecMut<T> {
     }
 
     fn append_nulls(&mut self, n: usize) {
-        self.elements.push_n(T::zero(), n);
+        self.elements.push_n(T::zero(), n); // Note that the value we push doesn't actually matter.
         self.validity.append_n(false, n);
     }
 

vortex-vector/src/struct_/vector.rs

@@ -20,12 +20,15 @@ pub struct StructVector {
 
     /// The length of the vector (which is the same as all field vectors).
     ///
-    /// This is stored here as a convenience.
+    /// This is stored here as a convenience, and also helps in the case that the `StructVector` has
+    /// no fields.
     pub(super) len: usize,
 
-    /// The capacity of the vector (which is the same as all field vectors).
+    /// The capacity of the vector (which is the less than or equal to the capacity of all field
+    /// vectors).
     ///
-    /// This is stored here as a convenience for converting to/from a [`StructVectorMut`].
+    /// This is stored here as a convenience for converting to/from a [`StructVectorMut`], and also
+    /// helps in the case that the `StructVector` has no fields.
     pub(super) capacity: usize,
 
     /// The validity mask (where `true` represents an element is **not** null).