Skip to content

Commit 060c12d

Browse files
committed
doc link updates
1 parent 17267d3 commit 060c12d

8 files changed

+22
-22
lines changed

src/edge_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ impl Iterator for EdgeTableIterator {
6666

6767
/// An immutable view of an edge table.
6868
///
69-
/// These are not created directly.
70-
/// Instead, use [`TableAccess::edges`](crate::TableAccess::edges)
71-
/// to get a reference to an existing edge table;
69+
/// These are not created directly but are accessed
70+
/// by types implementing [`std::ops::Deref`] to
71+
/// [`crate::table_views::TableViews`]
7272
#[repr(transparent)]
7373
pub struct EdgeTable {
7474
pub(crate) table_: NonNull<ll_bindings::tsk_edge_table_t>,

src/individual_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ impl PartialEq for IndividualTableRow {
4747

4848
/// An immutable view of a individual table.
4949
///
50-
/// These are not created directly.
51-
/// Instead, use [`TableAccess::individuals`](crate::TableAccess::individuals)
52-
/// to get a reference to an existing node table;
50+
/// These are not created directly but are accessed
51+
/// by types implementing [`std::ops::Deref`] to
52+
/// [`crate::table_views::TableViews`]
5353
pub struct IndividualTable {
5454
table_: NonNull<ll_bindings::tsk_individual_table_t>,
5555
}

src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ pub mod prelude;
9292
mod site_table;
9393
mod table_collection;
9494
mod table_iterator;
95-
mod table_views;
95+
pub mod table_views;
9696
mod traits;
9797
mod tree_interface;
9898
mod trees;

src/migration_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ impl Iterator for MigrationTableIterator {
7575

7676
/// An immutable view of a migration table.
7777
///
78-
/// These are not created directly.
79-
/// Instead, use [`TableAccess::migrations`](crate::TableAccess::migrations)
80-
/// to get a reference to an existing node table;
78+
/// These are not created directly but are accessed
79+
/// by types implementing [`std::ops::Deref`] to
80+
/// [`crate::table_views::TableViews`]
8181
pub struct MigrationTable {
8282
table_: NonNull<ll_bindings::tsk_migration_table_t>,
8383
}

src/mutation_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ impl Iterator for MutationTableIterator {
7878

7979
/// An immutable view of site table.
8080
///
81-
/// These are not created directly.
82-
/// Instead, use [`TableAccess::mutations`](crate::TableAccess::mutations)
83-
/// to get a reference to an existing mutation table;
81+
/// These are not created directly but are accessed
82+
/// by types implementing [`std::ops::Deref`] to
83+
/// [`crate::table_views::TableViews`]
8484
pub struct MutationTable {
8585
table_: NonNull<ll_bindings::tsk_mutation_table_t>,
8686
}

src/node_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ impl Iterator for NodeTableIterator {
6868

6969
/// An immtable view of a node table.
7070
///
71-
/// These are not created directly.
72-
/// Instead, use [`TableAccess::nodes`](crate::TableAccess::nodes)
73-
/// to get a reference to an existing node table;
71+
/// These are not created directly but are accessed
72+
/// by types implementing [`std::ops::Deref`] to
73+
/// [`crate::table_views::TableViews`]
7474
pub struct NodeTable {
7575
table_: NonNull<ll_bindings::tsk_node_table_t>,
7676
}

src/population_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ impl Iterator for PopulationTableIterator {
6363

6464
/// An immutable view of site table.
6565
///
66-
/// These are not created directly.
67-
/// Instead, use [`TableAccess::populations`](crate::TableAccess::populations)
68-
/// to get a reference to an existing population table;
66+
/// These are not created directly but are accessed
67+
/// by types implementing [`std::ops::Deref`] to
68+
/// [`crate::table_views::TableViews`]
6969
#[repr(transparent)]
7070
pub struct PopulationTable {
7171
table_: NonNull<ll_bindings::tsk_population_table_t>,

src/site_table.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ impl Iterator for SiteTableIterator {
6363

6464
/// An immutable view of site table.
6565
///
66-
/// These are not created directly.
67-
/// Instead, use [`TableAccess::sites`](crate::TableAccess::sites)
68-
/// to get a reference to an existing site table;
66+
/// These are not created directly but are accessed
67+
/// by types implementing [`std::ops::Deref`] to
68+
/// [`crate::table_views::TableViews`]
6969
pub struct SiteTable {
7070
table_: NonNull<ll_bindings::tsk_site_table_t>,
7171
}

0 commit comments

Comments
 (0)