tx-generator TODO cleanups #5296
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
NadiaYvette
force-pushed
the
nadia.chambers/tx-gen-cleanups-01
branch
3 times, most recently
from
61cb053 to
28191b3
Compare
NadiaYvette
force-pushed
the
nadia.chambers/tx-gen-cleanups-01
branch
2 times, most recently
from
0698a23 to
c333b38
Compare
NadiaYvette
force-pushed
the
nadia.chambers/tx-gen-cleanups-01
branch
4 times, most recently
from
635f87b to
5db1929
Compare
Avoid import and increase readability Avoid an import and increase readability
First cut at documenting Action. Clean up haddock warnings & add module header. Check in progress for Generator. The whole data structure wasn't gotten through, but some comments preparing for haddock, but not shown in it, were left on the cases of the coproduct that hadn't been completely deciphered yet. Beginnings of Env haddock This is only really being checked in because a pull and rebase demanded doing so. It would have been less log pollution if things wouldn't have been rebased until after various more complete steps had been completed. Module description for Env. Check in Error type description. Update haddock after new info from Micha. Document Selftest and Action modules. Document Wallet.
The module header haddock still had a reference to a function that had just been moved mentioning the circular module import issues moving it solved. Fix stray detritus from merginga in Action
Document the Fund module. This should silence some haddock warnings. Haddock for FundQueue. This was maybe too simple to merit documenting, but it silences haddock warnings. More docs and quieting haddock warnings. Some of these are a bit trivial. There may be some debate as to how worthwhile comments of these forms are. Some of the trivial and repetitive things might make sense to be done with lenses so as to cut down on what adds up to boilerplate code. Add haddock for the Fifo data structure The alternative implementation of removeN might be a bit verbose. Trim down the removeN comment to something saner. Document the Utils module. Haddock for PlutusContext.
NadiaYvette
force-pushed
the
nadia.chambers/tx-gen-cleanups-01
branch
from
5db1929 to
3f1e41f
Compare
mgmeier
approved these changes
Jun 21, 2023
| mangle :: Monad m => [ CreateAndStore m era ] -> CreateAndStoreList m era [ Lovelace ] | ||
| mangle fkts values | ||
| = (outs, \txId -> mapM_ (\f -> f txId) fs) | ||
| where | ||
| (outs, fs) =unzip $ map worker $ zip3 fkts values [TxIx 0 ..] | ||
| worker (toUTxO, value, idx) | ||
| (outs, fs) = unzip $ zipWith3 worker fkts values [TxIx 0 ..] |
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.
This addresses several places in the code marked with TODO, though the scope of the tasks marked strayed across modules sometimes. It also adds haddock documentation to a number of modules.