rust-bitcoin / rust-bitcoin/rust-miniscript
Model `OrdF64` as `NonNan`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 426
- Forks
- 200
- Avg merge
- 7d 17h
- Merged PRs (30d)
- 8
Description
It'd be better to model OrdF64 as NonNan because it brings panic (or error) closer to the cause of the issue making debugging easier. Potential inspiration: https://docs.rs/ordered-float/3.0.0/ordered_float/struct.NotNan.html
The change should be simple: make the field private and constructor panics or returns Result.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the OrdF64 definition, its field access, and all constructors and call sites. Read the linked ordered-float NotNan documentation for the intended model. Done means the field is private and construction either panics or returns Result, with affected uses updated accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- blockchain
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100