rust-bitcoin / rust-bitcoin/rust-bitcoin

Consider generalizing the `NumOpResult` type and module

Open
#4,042 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
2.7k
Forks
1k
Avg merge
4d 1h
Merged PRs (30d)
88

Description

If #4007 merges we could consider generalizing the units::amount::result module. That means:

  • Move the module out of amount
  • Change any docs and identifiers that refer to amounts

Originally suggested: https://github.com/rust-bitcoin/rust-bitcoin/pull/4007#discussion_r1951465812

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the units::amount::result module and the NumOpResult type, then inspect the changes discussed in PR #4007. Identify every amount-specific documentation reference and identifier, move the module to a suitable general location, and update those references so the generalized API is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.