From: merge-script <hello@evanlinjin.me>
Date: Fri, 16 May 2025 08:55:32 +0000 (+1000)
Subject: Merge bitcoindevkit/bdk#1806: fix(docs): `merge_chains` outdated documentation
X-Git-Tag: core-0.6.0~7
X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/static/enum.FromStrError.html?a=commitdiff_plain;h=75ef7c0e2c6a4ad8dcf4bb3a7658d1db8e4d541d;p=bdk

Merge bitcoindevkit/bdk#1806: fix(docs): `merge_chains` outdated documentation

5647241f45b29fe5f7ad5aa5a94c0c4f72f9adea fix(docs): `merge_chains` documentation (Leonardo Lima)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  It's a minor documentation fix, as reported during the audit and referenced in bitcoindevkit/bdk_wallet#59.

  <!-- Describe the purpose of this PR, what's being adding and/or fixed -->

  ### Notes to the reviewers

  I'm unsure if anything else / any other explanation should be included in the documentation. Let me know if you think more context should be added to it.

  <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
  of the PR were done in a specific way -->

  ### Changelog notice

  - Update `bdk_chain::local_chain::merge_chains` documentation.

  <!-- Notice the release manager should include in the release tag message changelog -->
  <!-- See https://keepachangelog.com/en/1.0.0/ for examples -->

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  evanlinjin:
    self-ACK 5647241f45b29fe5f7ad5aa5a94c0c4f72f9adea

Tree-SHA512: a70a67eab9c8fa0c60a674efed82ddeb9bc9b69763fefaa38a9058d7a1e67c06045c3e5a31aaf0d48c0a599d03bac0a3a86530cc250acefea9497572c01b8b0e
---

75ef7c0e2c6a4ad8dcf4bb3a7658d1db8e4d541d