doc

Author: molpopgen

src/traits.rs

@@ -150,19 +150,30 @@ pub trait TableColumn<I, T>:
     + std::ops::Index<crate::SizeType, Output = T>
     + private::TableColumnMarker
 {
+    /// Get the underlying slice
     fn as_slice(&self) -> &[T];
+
+    /// The "standard" get function
     fn get(&self, at: usize) -> Option<&T>;
+
+    /// Get with a table row identifier such as [`crate::NodeId`]
     fn get_with_id(&self, at: I) -> Option<&T>;
+
+    /// Get with [`crate::SizeType`]
     fn get_with_size_type(&self, at: crate::SizeType) -> Option<&T>;
+
+    /// Iterator over the data.
     fn iter<'a, 'b>(&'a self) -> impl Iterator<Item = &'b T>
     where
         'a: 'b,
         T: 'b;
 
+    /// Column length
     fn len(&self) -> usize {
         self.as_slice().len()
     }
 
+    /// Query if column is empty
     fn is_empty(&self) -> bool {
         self.as_slice().is_empty()
     }