add Warning to other sort fns

Author: molpopgen

examples/forward_simulation.rs

@@ -18,7 +18,7 @@
  *   and numbers of crossovers, etc.., from being entered
  *   on the command line.
  */
-use clap::{Command, Arg};
+use clap::{Arg, Command};
 use rand::rngs::StdRng;
 use rand::Rng;
 use rand::SeedableRng;

examples/tree_traversals.rs

@@ -1,4 +1,4 @@
-use clap::{Command, Arg};
+use clap::{Arg, Command};
 use tskit::prelude::*;
 
 // "Manual" traversal from samples to root

src/table_collection.rs

@@ -598,6 +598,12 @@ impl TableCollection {
     /// Sort the tables.  
     /// The [``bookmark``](crate::types::Bookmark) can
     /// be used to affect where sorting starts from for each table.
+    ///
+    /// # Warning
+    ///
+    /// As of `0.7.0`, this function does not sort the individual table!
+    /// See
+    /// [``topological_sort_individuals``](crate::TableCollection::topological_sort_individuals).
     pub fn sort(&mut self, start: &Bookmark, options: TableSortOptions) -> TskReturnValue {
         let rv = unsafe {
             ll_bindings::tsk_table_collection_sort(
@@ -612,6 +618,12 @@ impl TableCollection {
 
     /// Fully sort all functions.
     /// Implemented via a call to [``sort``](crate::TableCollection::sort).
+    ///
+    /// # Warning
+    ///
+    /// As of `0.7.0`, this function does not sort the individual table!
+    /// See
+    /// [``topological_sort_individuals``](crate::TableCollection::topological_sort_individuals).
     pub fn full_sort(&mut self, options: TableSortOptions) -> TskReturnValue {
         let b = Bookmark::new();
         self.sort(&b, options)