Skip to content

Commit 94b20ef

Browse files
authored
doc: fix lints from rustdoc (#631)
1 parent 9f60505 commit 94b20ef

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/error.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ pub fn get_tskit_error_message(code: i32) -> String {
6262
sys::get_tskit_error_message(code)
6363
}
6464

65-
/// Given an instance of [``TskReturnValue``](crate::TskReturnValue),
65+
/// Given an instance of [``TskReturnValue``],
6666
/// obtain the tskit error message if there is indeed an error.
6767
pub fn extract_error_message(x: TskReturnValue) -> Option<String> {
6868
x.map_or_else(|e: TskitError| Some(format!("{}", e)), |_| None)

src/trees/treeseq.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,8 @@ impl TreeSequence {
292292
/// # Parameters
293293
///
294294
/// * `lambda` specifies the relative weight of topology and branch length.
295-
/// See [`TreeInterface::kc_distance`] for more details.
295+
/// If `lambda` is 0, we only consider topology.
296+
/// If `lambda` is 1, we only consider branch lengths.
296297
pub fn kc_distance(&self, other: &TreeSequence, lambda: f64) -> Result<f64, TskitError> {
297298
self.inner.kc_distance(&other.inner, lambda)
298299
}

0 commit comments

Comments
 (0)