-
Notifications
You must be signed in to change notification settings - Fork 141
Improve documentation for immutable vectors #398
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
Conversation
I only skimmed generic module. So far PR looks good |
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!!!! 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.
Co-authored-by: Alexey Kuleshevich <[email protected]>
I'm not quite sure how |
@konsumlamm Could you also rebase on master, there are some conflicts since #397 has been merged |
Looks like it's supposed to generate tuple instances as text. Great work! I don't have any more suggestions, @lehins caught everything |
@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.Storable
andData.Vector.Unboxed
are mostly the same as inData.Vector.Generic
.I plan to make followup PRs for the documentation of mutable vectors and fusion.