Skip to content

doc: fix some doc errors #898

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
May 5, 2026
Merged

doc: fix some doc errors #898

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
12 changes: 2 additions & 10 deletions src/trees/tree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,13 +292,13 @@ impl<'treeseq> Tree<'treeseq> {
///
/// # Parameters
///
/// * `rooit`: the subtree root
/// * `root`: the subtree root
/// * `order`: A value from [`crate::NodeTraversalOrder`] specifying the
/// iteration order.
///
/// # Errors
///
/// * [`TskitError`] if `node` is null or out of bounds.
/// * [`TskitError`] if `root` is null or out of bounds.
pub fn traverse_nodes_from_root(
&self,
root: NodeId,
Expand All @@ -308,10 +308,6 @@ impl<'treeseq> Tree<'treeseq> {
}

/// Return an [`Iterator`] over the children of node `u`.
/// # Returns
///
/// * `Some(iterator)` if `u` is valid
/// * `None` otherwise
pub fn children<N: Into<NodeId> + Copy>(
&self,
u: N,
Expand All @@ -320,10 +316,6 @@ impl<'treeseq> Tree<'treeseq> {
}

/// Return an [`Iterator`] over the parents of node `u`.
/// # Returns
///
/// * `Some(iterator)` if `u` is valid
/// * `None` otherwise
pub fn parents<N: Into<NodeId> + Copy>(&self, u: N) -> impl Iterator<Item = NodeId> + '_ {
self.inner.parents(u.into())
}
Expand Down
Loading