From 94b20ef83ce25bbcbf751c853d2c0f210f3782c4 Mon Sep 17 00:00:00 2001 From: "Kevin R. Thornton" Date: Tue, 7 May 2024 16:05:09 -0700 Subject: [PATCH] doc: fix lints from rustdoc (#631) --- src/error.rs | 2 +- src/trees/treeseq.rs | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/error.rs b/src/error.rs index 9acc6d4c..aa9fb644 100644 --- a/src/error.rs +++ b/src/error.rs @@ -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 { x.map_or_else(|e: TskitError| Some(format!("{}", e)), |_| None) diff --git a/src/trees/treeseq.rs b/src/trees/treeseq.rs index e7afdba6..f02d91ec 100644 --- a/src/trees/treeseq.rs +++ b/src/trees/treeseq.rs @@ -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 { self.inner.kc_distance(&other.inner, lambda) }