Public API of CoinSelection Module.
#53
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These will be omitted from generated documentation.
If the user wishes to perform validation, they can perform it after calling `selectCoins`.
To `CoinSelectionInputLimit`. Justification: the record now only provides this item.
This type holds all parameters required by a coin selection algorithm.
This type holds all values returned by a `CoinSelectionAlgorithm`.
Additionally, change the order in which coin selection types are presested in the generated documentation.
jonathanknowles
force-pushed
the
jonathanknowles/module-structure-and-docs
branch
from
468af7f
to
49de122
Compare
This is for consistency with naming elsewhere.
jonathanknowles
changed the title
This has two advantages: 1. We can give field names to error parameters. 2. There's more documentation space to explain each error condition. This change also adds documentation for each error condition that links back to types defined in the CoinSelection module.
jonathanknowles
force-pushed
the
jonathanknowles/module-structure-and-docs
branch
from
c8c94d0
to
40f353d
Compare
jonathanknowles
changed the title
CoinSelection module.
jonathanknowles
changed the title
CoinSelection module.CoinSelection Module.
In response to review feedback: #53 (comment)
In response to review feedback: #53 (comment)
18 tasks
paweljakubas
approved these changes
Apr 22, 2020
|
@paweljakubas wrote:
Thanks for reviewing it! |
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue
#18
#30
Summary
This PR makes a number of changes aimed at improving the public API and documentation:
CoinSelectionmodule.OPTIONS_HADDOCK pruneto hide internal functions from Haddock documentation.Showinstances more informative.CoinSelection, they can easily validate it themselves after callingselectCoins.