Skip to content

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

Merged
merged 7 commits into from
Aug 10, 2021

Conversation

konsumlamm
Copy link
Contributor

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 and Data.Vector.Unboxed are mostly the same as in Data.Vector.Generic.

I plan to make followup PRs for the documentation of mutable vectors and fusion.

@Shimuuar
Copy link
Contributor

Shimuuar commented Aug 9, 2021

I only skimmed generic module. So far PR looks good

Copy link
Contributor

@lehins lehins left a 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.

@konsumlamm
Copy link
Contributor Author

I'm not quite sure how internal/GenUnboxTuple.hs is supposed to work, so I just added the dots in there and in internal/unbox-tuple-instances.

@konsumlamm konsumlamm requested a review from lehins August 10, 2021 13:25
@lehins
Copy link
Contributor

lehins commented Aug 10, 2021

@konsumlamm Could you also rebase on master, there are some conflicts since #397 has been merged

@Shimuuar
Copy link
Contributor

I'm not quite sure how internal/GenUnboxTuple.hs is supposed to work, so I just added the dots in there and in internal/unbox-tuple-instances.

Looks like it's supposed to generate tuple instances as text.

Great work! I don't have any more suggestions, @lehins caught everything

@lehins lehins merged commit 7ddd008 into haskell:master Aug 10, 2021
@lehins
Copy link
Contributor

lehins commented Aug 10, 2021

@konsumlamm thank you!

@konsumlamm konsumlamm deleted the documentation-immutable branch August 10, 2021 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants