Skip to content

style(docs): minor formatting fixes #828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
molpopgen merged 1 commit into from
Mar 12, 2026
Merged

style(docs): minor formatting fixes #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/table_collection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ use ll_bindings::tsk_size_t;
/// # Examples
///
/// ```
///
/// let mut tables = tskit::TableCollection::new(100.).unwrap();
/// assert_eq!(tables.sequence_length(), 100.);
///
Expand Down Expand Up @@ -235,7 +234,6 @@ impl TableCollection {
///
/// ```
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
///
/// // left, right, parent, child
/// match tables.add_edge(0., 53., 1, 11) {
/// // This is the first edge, so its id will be
Expand Down Expand Up @@ -379,7 +377,6 @@ impl TableCollection {
///
/// ```
/// # #[cfg(feature = "derive")] {
///
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::IndividualMetadata)]
/// # #[serializer("serde_json")]
Expand Down Expand Up @@ -764,7 +761,7 @@ impl TableCollection {
}
}

/// Sort the tables.
/// Sort the tables.
/// The [``bookmark``](crate::types::Bookmark) can
/// be used to affect where sorting starts from for each table.
///
Expand Down
8 changes: 4 additions & 4 deletions src/trees/tree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ impl<'treeseq> Tree<'treeseq> {

/// # Failing examples
///
/// An error will be returned if ['TreeFlags::SAMPLE_LISTS`](crate::TreeFlags::SAMPLE_LISTS) is not used:
/// An error will be returned if [`TreeFlags::SAMPLE_LISTS`] is not used:
///
/// ```should_panic
/// use tskit::StreamingIterator;
Expand Down Expand Up @@ -337,7 +337,7 @@ impl<'treeseq> Tree<'treeseq> {

/// # Failing examples
///
/// An error will be returned if ['TreeFlags::SAMPLE_LISTS`](crate::TreeFlags::SAMPLE_LISTS) is not used:
/// An error will be returned if [`TreeFlags::SAMPLE_LISTS`] is not used:
///
/// ```should_panic
/// use tskit::StreamingIterator;
Expand Down Expand Up @@ -371,7 +371,7 @@ impl<'treeseq> Tree<'treeseq> {

/// # Failing examples
///
/// An error will be returned if ['TreeFlags::SAMPLE_LISTS`](crate::TreeFlags::SAMPLE_LISTS) is not used:
/// An error will be returned if [`TreeFlags::SAMPLE_LISTS`] is not used:
///
/// ```should_panic
/// use tskit::StreamingIterator;
Expand Down Expand Up @@ -405,7 +405,7 @@ impl<'treeseq> Tree<'treeseq> {

/// # Failing examples
///
/// An error will be returned if ['TreeFlags::SAMPLE_LISTS`](crate::TreeFlags::SAMPLE_LISTS) is not used:
/// An error will be returned if [`TreeFlags::SAMPLE_LISTS`] is not used:
///
/// ```should_panic
/// use tskit::StreamingIterator;
Expand Down
Loading