Skip to content

Commit 634df56

Browse files
authored
Fix docs for Tree::total_branch_length. Fixes #114. (#124)
1 parent 202bcde commit 634df56

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/trees.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ impl Tree {
513513
///
514514
/// # Errors
515515
///
516-
/// [`TskitError`] may be returned via [`Tree::traverse_nodes`].
516+
/// [`TskitError`] may be returned if a node index is out of range.
517517
pub fn total_branch_length(&self, by_span: bool) -> Result<f64, TskitError> {
518518
let nt = self.node_table();
519519
let mut b = 0.;

0 commit comments

Comments
 (0)