bitcoindevkit / bdk / 12318424659

79%

push

github

Merge bitcoindevkit/bdk#1680: docs(wallet): reword the `next_unused_address` doc

<a class=hub.com/bitcoindevkit/bdk/commit/<a class="double-link" href="https://git"><a class=hub.com/bitcoindevkit/bdk/commit/b39cf08c98d9a5b53bb0eacd53c71c341ba37f76">b39cf08c9 docs(wallet): reword the `next_unused_address` doc (Leonardo Lima)

Pull request description:

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

  ### Description

  Adds an example on what `used` stands for, and make it explicit that it
  has the same behavior as `Wallet::reveal_next_address` in the scenario
  where all previously revealed addresses have been used.

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

  ### Notes to the reviewers

  Is there any other behavior of `next_unused_address` we'd need to make clear through documentation ?

  <!-- 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

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

  - Improve the `Wallet::next_unused_address` documentation to better describe expected behavior/usage.

  ### 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

  #### New Features:

  * [ ] I've added tests for the new feature
  * [ ] I've added docs for the new feature

  #### Bugfixes:

  * [ ] This pull request breaks the existing API
  * [ ] I've added tests to reproduce the issue which are now passing
  * [ ] I'm linking the issue being fixed by this PR

ACKs for top commit:
  notmandatory:
    ACK b39cf08c98d9a5b53bb0eacd53c71c341ba37f76
  ValuedMammal:
    ACK b39cf08c98d9a5b53bb0eacd53c71c341ba37f76

Tree-SHA512: af4e912db889cf345c1... (continued)

11976 of 14283 relevant lines covered (83.85%)

20273.0 hits per line