Merge pull request #45 from molpopgen/documentation

Documentation

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,

src/table_collection.rs

@@ -185,11 +185,11 @@ impl TableCollection {
         population: tsk_id_t,
         individual: tsk_id_t,
     ) -> TskReturnValue {
-        self.add_node_witha_metadata(flags, time, population, individual, None)
+        self.add_node_with_metadata(flags, time, population, individual, None)
     }
 
     /// Add a row with metadata to the node table
-    pub fn add_node_witha_metadata(
+    pub fn add_node_with_metadata(
         &mut self,
         flags: ll_bindings::tsk_flags_t,
         time: f64,