-
Notifications
You must be signed in to change notification settings - Fork 550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[pickles] Document Hlist #10232
[pickles] Document Hlist #10232
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At a glance this looks great o_O!! Two small questions:
- did you manage to build HTML documentation out of these files? I couldn't when I tried
- unrelated to this PR, but do you think this should live outside of pickles, as its own library or as part of a utility library?
Yup! I had to build the whole documentation for the repo by running
I'd love to have a generic HList library living completely outside of Mina. However here |
335af59
to
e01d9cb
Compare
349f50f
to
5bfc4bc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me! I've sprinkled a few nits, but this is already a huge improvement.
1 caveat: I suspect you didn't intend to update the snarky submodule 😁
d679232
to
ebebe99
Compare
8fd9618
to
dd9f323
Compare
Removed that nasty change from the commit 😅 Good work for noticing that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent!
dd9f323
to
f2352d2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Submodule updates have slipped back in.
(Also, if you force push rather than adding new commits, I can't easily track what's changed between one review and the next, which is a pain.)
f2352d2
to
518d06f
Compare
Right, sorry. Force-pushed a last time to remove the submodule updates again. I like to keep a clean history but I guess I should rebase at the very end before merging instead of doing it continuously. |
We've been running with a policy of 'merge what was approved' and 'don't change branches out from under reviewers'. Our git history is a mess, but reviews and merges are way easier than they were before. |
Add considerable documentation to
Hlist
in thepickles
lib, in a new MLI file.Also renames
Fst
andSnd
toArg1
andArg2
, and removesHlist_1
, which is redundant withHlist0.H1_1
.