Revise Documentation for the Migration Module.
#55
Conversation
|
@KtorZ I suspect this part could also be revised, as the values seem very specific to Cardano: |
|
@rvl At this stage it does not. But it'll be only useful by the time we make a second release indeed. |
This makes the batch size argument easier to refer to in documentation for the `Migration.selectCoins` function, and provides a way to relate `idealBatchSize` to `selectCoins`.
Remove Cardano-specific blockchain constants, and write a more general description that could be applied to any UTxO-based blockchain.
jonathanknowles
force-pushed
the
KtorZ/small-doc-tweaks
branch
from
a3d8536
to
0bab2e8
Compare
|
@rvl wrote:
After an internal team discussion, it was decided to include this attribute on every symbol exported in the public API right from the first published version. |
|
@jonathanknowles wrote:
Fixed in 0bab2e8. |
jonathanknowles
changed the title
Migration Module.
| -- wallet to another. | ||
| -- | ||
| -- Since UTxO-based blockchains typically impose limits on the sizes of | ||
| -- individual transactions, and since individual UTxO sets can contain |
There was a problem hiding this comment.
UTxO sets ot UTxO set ?
There was a problem hiding this comment.
UTxO setsotUTxO set?
This is correct, because we've written:
"individual UTxO sets can contain arbitrarily many entries."
(The sentence is referring to the concept of UTxO sets in general.)
We could also have written:
"an individual UTxO set can contain arbitrarily many entries."
(Either would be correct.)
Related Issue
#18
Summary
This PR:
Migrationmodule to be more general, removing references to Cardano-specific blockchain values.BatchSize, which makes the batch size argument easier to refer to in documentation, and provides a way for users to relate theidealBatchSizeandselectCoinsfunctions to one another.idealBatchSizein the public API.In addition, this PR:
@since 1.0.0metadata attribute to each symbol exposed in the public API. (The necessity of this was discussed in an earlier review, and a consensus was reached that we will include an attribute for each symbol in the public API, right from the first release.)