Add documentation related to Tree/TreeSequence

Author: molpopgen

src/error.rs

@@ -14,7 +14,7 @@ pub enum TskitError {
     #[error("Invalid index")]
     IndexError,
     /// Raised when samples are requested from
-    /// [`Tree`] objects, but sample lists are
+    /// [`crate::Tree`] objects, but sample lists are
     /// not being updated.
     #[error("Not tracking samples in Trees")]
     NotTrackingSamples,

src/ffi.rs

@@ -8,6 +8,8 @@ pub trait TskitTypeAccess<T> {
     fn as_mut_ptr(&mut self) -> *mut T;
 }
 
+/// Indexable, iterable wrapper around C
+/// arrays.
 #[derive(Copy, Clone)]
 pub(crate) struct WrappedTskArray<T> {
     array: T,