Skip to content

Commit

Permalink
Merge pull request #71 from molpopgen/fix_doc_issues
Browse files Browse the repository at this point in the history
Closes #66
  • Loading branch information
molpopgen authored Mar 29, 2021
2 parents 9e56d40 + a6b9298 commit dffc91a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
//! used during the simulation. Thus, it is not
//! part of a [``TableCollection``] and is something
//! that would only be useful to write when transfering
//! final results ot a [``tskit_rust::TableCollection``].
//! final results to a [`tskit::TableCollection`](::tskit::TableCollection).
//! 4. Mutation table data are different. See [``MutationRecord``].
//! 5. Time is measured as an integer (see [``Time``]),
//! as are genomic locations (see [``Position``]).
Expand Down
3 changes: 1 addition & 2 deletions src/simplification.rs
Original file line number Diff line number Diff line change
Expand Up @@ -636,8 +636,7 @@ impl Default for SimplificationOutput {
/// During simplification, several large
/// memory blocks are required. This type
/// allows those allocations to be re-used
/// in subsequent calls to
/// [simplify_tables_with_state](fn.simplify_tables_with_state.html).
/// in subsequent calls to [``simplify_tables``].
/// Doing so typically improves run times at
/// the cost of higher peak memory consumption.
pub struct SimplificationBuffers {
Expand Down
4 changes: 2 additions & 2 deletions src/tables.rs
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ impl TableCollection {
///
/// The [``u8``] type can be used to encode more complex
/// state information. Take a look at the unit tests
/// for examples. The [bitfield](https://crates.io/crates/bitfield)
/// for examples. The [bitfield](https://docs.rs/bitfield/)
/// crate may also be useful.
///
/// # Returns
Expand Down Expand Up @@ -571,7 +571,7 @@ impl TableCollection {
///
/// The [``u8``] type can be used to encode more complex
/// state information. Take a look at the unit tests
/// for examples. The [bitfield](https://crates.io/crates/bitfield)
/// for examples. The [bitfield](https://docs.rs/bitfield/)
/// crate may also be useful.
///
/// # Returns
Expand Down

0 comments on commit dffc91a

Please sign in to comment.