Commit fbf803a
committed
Merge #422: docs(wallet): fix misleading RBF comment in
76a8cc6 docs(wallet): fix misleading RBF comment in `create_tx` (Vadim Anufriev)
Pull request description:
### Description
Fix misleading comment in `create_tx` regarding empty tx output logic. This addresses a documentation nitpick brought up by the 2024 [WizardSardine report](https://bitcoindevkit.org/audits/2024_q4/bdk_audit_report).
- Replaced incorrect RBF example with sweeping UTXOs
- Reordered comment items to match the code's condition order
Closes #45
### Changelog notice
Fixed:
- Fix docs for `Wallet:create_tx` when empty output vector
### 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 `just p` before pushing
ACKs for top commit:
luisschwab:
ACK 76a8cc6
Tree-SHA512: 6a788ffafbf195da2b6ef39b605319aec480dea8896dedc38a0244e3902e7f697611725ddfe81ca25204916802b4a6c5784d96ee1e78d21a003acdd3d8ef081fcreate_tx
1 file changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1492 | 1492 | | |
1493 | 1493 | | |
1494 | 1494 | | |
1495 | | - | |
1496 | | - | |
1497 | | - | |
1498 | | - | |
| 1495 | + | |
| 1496 | + | |
| 1497 | + | |
| 1498 | + | |
1499 | 1499 | | |
1500 | 1500 | | |
1501 | 1501 | | |
| |||
0 commit comments