bitcoindevkit / bitcoindevkit/bdk-ffi
Fix docs on `Psbt::extract_tx`
Open
- Dominant language
- Rust
- Stars
- 127
- Forks
- 81
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 5
Description
Our API docs mirror the Rust side, but our errors don't, making the API docs incorrect. We should either:
1. Fix the docs
2. See if we can expand the error to include the data required to make the docs valid!
Contributor guide
No contributing guide indexed for this repository
Research direction
Start at the Psbt::extract_tx API documentation and compare it with the Rust-side documentation and the current error returned by the API. Determine whether the documented behavior or the error data needs to change; done means the API docs accurately describe the available error information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100