Uh oh!
There was an error while loading. Please reload this page.
Improve documentation for immutable vectors - #398
Conversation
Uh oh!
There was an error while loading. Please reload this page.
Shimuuar
commented
Aug 9, 2021
I only skimmed generic module. So far PR looks good |
lehins
left a comment
There was a problem hiding this comment.
This looks great!!!! Thank you for doing all the tedious work.
The only thing that bothers me is the default (Int) for Primitive, Storable and Unboxed. I mention this in one of the comments, but I'll say it here too. Problem is that it is not visible to the user and I believe it will raise more questions that the problems it will solve.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Alexey Kuleshevich <lehins@yandex.ru>
konsumlamm
commented
Aug 10, 2021
I'm not quite sure how |
lehins
commented
Aug 10, 2021
@konsumlamm Could you also rebase on master, there are some conflicts since #397 has been merged |
Shimuuar
commented
Aug 10, 2021
Looks like it's supposed to generate tuple instances as text. Great work! I don't have any more suggestions, @lehins caught everything |
lehins
commented
Aug 10, 2021
@konsumlamm thank you! |
This PR imrpoves the doc comments for the immutable vector related modules (and a small change in
README.md/vector.cabal).I'm sorry that this will probably take a while to review, the main reason for that is that all the doc comments are duplicated. The changes in
Data.Vector,Data.Vector.Primitive,Data.Vector.StorableandData.Vector.Unboxedare mostly the same as inData.Vector.Generic.I plan to make followup PRs for the documentation of mutable vectors and fusion.