Skip to content

Commit

Permalink
doc: fix lints from rustdoc (#631)
Browse files Browse the repository at this point in the history
  • Loading branch information
molpopgen authored May 7, 2024
1 parent 9f60505 commit 94b20ef
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ pub fn get_tskit_error_message(code: i32) -> String {
sys::get_tskit_error_message(code)
}

/// Given an instance of [``TskReturnValue``](crate::TskReturnValue),
/// Given an instance of [``TskReturnValue``],
/// obtain the tskit error message if there is indeed an error.
pub fn extract_error_message(x: TskReturnValue) -> Option<String> {
x.map_or_else(|e: TskitError| Some(format!("{}", e)), |_| None)
Expand Down
3 changes: 2 additions & 1 deletion src/trees/treeseq.rs
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,8 @@ impl TreeSequence {
/// # Parameters
///
/// * `lambda` specifies the relative weight of topology and branch length.
/// See [`TreeInterface::kc_distance`] for more details.
/// If `lambda` is 0, we only consider topology.
/// If `lambda` is 1, we only consider branch lengths.
pub fn kc_distance(&self, other: &TreeSequence, lambda: f64) -> Result<f64, TskitError> {
self.inner.kc_distance(&other.inner, lambda)
}
Expand Down

0 comments on commit 94b20ef

Please sign in to comment.