Skip to content

docs(wallet): fix misleading RBF comment in create_tx#422

Merged
ValuedMammal merged 1 commit intobitcoindevkit:masterfrom
va-an:docs/fix-create-tx-empty-outputs
Apr 14, 2026
Merged

docs(wallet): fix misleading RBF comment in create_tx#422
ValuedMammal merged 1 commit intobitcoindevkit:masterfrom
va-an:docs/fix-create-tx-empty-outputs

Conversation

@va-an
Copy link
Copy Markdown
Contributor

@va-an va-an commented Mar 27, 2026

Description

Fix misleading comment in create_tx regarding empty tx output logic. This addresses a documentation nitpick brought up by the 2024 WizardSardine 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:

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.04%. Comparing base (fb7681a) to head (76a8cc6).
⚠️ Report is 10 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #422   +/-   ##
=======================================
  Coverage   80.04%   80.04%           
=======================================
  Files          24       24           
  Lines        5336     5336           
  Branches      242      242           
=======================================
  Hits         4271     4271           
  Misses        987      987           
  Partials       78       78           
Flag Coverage Δ
rust 80.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ValuedMammal ValuedMammal moved this to Needs Review in BDK Wallet Mar 30, 2026
@ValuedMammal ValuedMammal added this to the Wallet 3.1.0 milestone Mar 30, 2026
@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Apr 6, 2026

ACK 62409a5 I agree the comment was confusing and at least now it better describes what the code is doing.

Comment thread src/wallet/mod.rs
@luisschwab
Copy link
Copy Markdown
Member

Can you squash the commits?

- Replace incorrect RBF example with sweeping UTXOs
- Reorder comment items to match the code's condition order
@va-an va-an force-pushed the docs/fix-create-tx-empty-outputs branch from 00efc45 to 76a8cc6 Compare April 7, 2026 11:44
Copy link
Copy Markdown
Member

@luisschwab luisschwab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 76a8cc6

@luisschwab luisschwab requested a review from ValuedMammal April 7, 2026 12:53
@ValuedMammal ValuedMammal added audit Suggested as result of external code audit documentation Improvements or additions to documentation labels Apr 14, 2026
@ValuedMammal ValuedMammal merged commit fbf803a into bitcoindevkit:master Apr 14, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Review to Done in BDK Wallet Apr 14, 2026
@va-an va-an deleted the docs/fix-create-tx-empty-outputs branch April 15, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

audit Suggested as result of external code audit documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Fix docs for Wallet:create_tx when empty output vector

3 participants