IntersectMBO / IntersectMBO/cardano-ledger
Better documentation of `setMinCoinTxOut` and `ensureMinCoinTxOut` in `Cardano.Ledger.Api.Tx.Out`
- Dominant language
- Haskell
- Stars
- 295
- Forks
- 179
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 30
Description
Document (with Haddock examples) `getMinCoinTxOut` and mention the difference with using `Cardano.Ledger.Api.Tx.Out.setMinCoinSizedTxOut` and `Cardano.Ledger.Api.Tx.Out.setMinCoinTxOut` vs simply setting the min value to what `getMinCoinTxOut` returns. Show examples on how to use it and what the expected result should be.
Contributor guide
Research direction
Start with the Haddock documentation for Cardano.Ledger.Api.Tx.Out, focusing on getMinCoinTxOut, setMinCoinSizedTxOut, and setMinCoinTxOut. Add examples showing how each function is used, the difference between them, and the expected result of using the minimum value returned by getMinCoinTxOut.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- blockchain, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100