fix(docs): merge_chains documentation

- it's a small fix for `merge_chains` docs, reported on audit.
bitcoindevkit · Jan 21, 2025 · 7b166bf · 7b166bf
1 parent b7d64c2
commit 7b166bf
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/crates/chain/src/local_chain.rs b/crates/chain/src/local_chain.rs
@@ -545,8 +545,10 @@ impl std::error::Error for ApplyHeaderError {}
 
 /// Applies `update_tip` onto `original_tip`.
 ///
-/// On success, a tuple is returned `(changeset, can_replace)`. If `can_replace` is true, then the
-/// `update_tip` can replace the `original_tip`.
+/// On success, a tuple is returned `([`CheckPoint`], [`ChangeSet`])`.
+///
+/// [`CheckPoint`]: bdk_core::CheckPoint
+/// [`ChangeSet`]: bdk_chain::local_chain::CheckPoint
 fn merge_chains(
     original_tip: CheckPoint,
     update_tip: CheckPoint,