new doc tests

Author: molpopgen

src/trees.rs

@@ -163,6 +163,26 @@ impl streaming_iterator::DoubleEndedStreamingIterator for Tree {
 ///
 /// // tables gets moved into our treeseq variable:
 /// let treeseq = tables.tree_sequence(tskit::TreeSequenceFlags::default()).unwrap();
+/// assert_eq!(treeseq.nodes().num_rows(), 3);
+/// assert_eq!(treeseq.edges().num_rows(), 2);
+/// ```
+///
+/// This type does not [`std::ops::DerefMut`] to [`crate::table_views::TableViews`]:
+///
+/// ```compile_fail
+/// # let mut tables = tskit::TableCollection::new(1000.).unwrap();
+/// # tables.add_node(0, 1.0, tskit::PopulationId::NULL, tskit::IndividualId::NULL).unwrap();
+/// # tables.add_node(0, 0.0, tskit::PopulationId::NULL, tskit::IndividualId::NULL).unwrap();
+/// # tables.add_node(0, 0.0, tskit::PopulationId::NULL, tskit::IndividualId::NULL).unwrap();
+/// # tables.add_edge(0., 1000., 0, 1).unwrap();
+/// # tables.add_edge(0., 1000., 0, 2).unwrap();
+///
+/// # // index
+/// # tables.build_index();
+///
+/// # // tables gets moved into our treeseq variable:
+/// # let treeseq = tables.tree_sequence(tskit::TreeSequenceFlags::default()).unwrap();
+/// assert_eq!(treeseq.nodes_mut().num_rows(), 3);
 /// ```
 pub struct TreeSequence {
     pub(crate) inner: ll_bindings::tsk_treeseq_t,