refactor: mod table_view is no longer pub (#483)

* remove doc links to (now) private type

While technically a breaking change, the type in this mod
had no pub fields nor a way to construct. Code will
only break if it referred to this module for some reason.

Author: molpopgen

src/edge_table.rs

@@ -138,10 +138,6 @@ impl<'a> streaming_iterator::StreamingIterator for EdgeTableRowView<'a> {
 }
 
 /// An immutable view of an edge table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[repr(transparent)]
 #[derive(Debug)]
 pub struct EdgeTable {

src/individual_table.rs

@@ -96,10 +96,6 @@ impl<'a> streaming_iterator::StreamingIterator for IndividualTableRowView<'a> {
 }
 
 /// An immutable view of a individual table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct IndividualTable {

src/lib.rs

@@ -95,7 +95,7 @@ mod site_table;
 mod sys;
 mod table_collection;
 mod table_iterator;
-pub mod table_views;
+mod table_views;
 mod traits;
 mod tree_interface;
 mod trees;

src/migration_table.rs

@@ -158,10 +158,6 @@ impl<'a> streaming_iterator::StreamingIterator for MigrationTableRowView<'a> {
 }
 
 /// An immutable view of a migration table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct MigrationTable {

src/mutation_table.rs

@@ -155,10 +155,6 @@ impl<'a> streaming_iterator::StreamingIterator for MutationTableRowView<'a> {
 }
 
 /// An immutable view of site table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct MutationTable {

src/node_table.rs

@@ -139,10 +139,6 @@ impl<'a> streaming_iterator::StreamingIterator for NodeTableRowView<'a> {
 }
 
 /// An immtable view of a node table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct NodeTable {

src/population_table.rs

@@ -107,10 +107,6 @@ impl<'a> streaming_iterator::StreamingIterator for PopulationTableRowView<'a> {
 }
 
 /// An immutable view of site table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[repr(transparent)]
 #[derive(Debug)]
 pub struct PopulationTable {

src/site_table.rs

@@ -125,10 +125,6 @@ impl<'a> streaming_iterator::StreamingIterator for SiteTableRowView<'a> {
 }
 
 /// An immutable view of site table.
-///
-/// These are not created directly but are accessed
-/// by types implementing [`std::ops::Deref`] to
-/// [`crate::table_views::TableViews`]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct SiteTable {

src/trees.rs

@@ -166,7 +166,7 @@ impl streaming_iterator::DoubleEndedStreamingIterator for Tree {
 /// assert_eq!(treeseq.edges().num_rows(), 2);
 /// ```
 ///
-/// This type does not [`std::ops::DerefMut`] to [`crate::table_views::TableViews`]:
+/// This type does not provide access to mutable tables.
 ///
 /// ```compile_fail
 /// # let mut tables = tskit::TableCollection::new(1000.).unwrap();