Skip to content

Improve documentation for mutable vectors - #404

Merged
lehins merged 2 commits into
haskell:masterfrom
konsumlamm:documentation-mutable
Aug 15, 2021
Merged

Improve documentation for mutable vectors#404
lehins merged 2 commits into
haskell:masterfrom
konsumlamm:documentation-mutable

Conversation

@konsumlamm

Copy link
Copy Markdown
Contributor

Followup to #398.

This PR improves the doc comments for the mutable vector related modules (and a small fix in Data.Vector.Primitive).

Planned future work is to improve the docs for the fusion related modules and to add more complexity annotations to the (especially mutable vector) functions.

@lehinslehins left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you again for doing this work. Looks good overall, but a few minor changes.

Comment threadvector/src/Data/Vector/Generic/Mutable.hs
Comment threadvector/src/Data/Vector/Primitive.hs
Comment threadvector/src/Data/Vector/Primitive/Mutable.hs Outdated
@konsumlamm
konsumlammforce-pushed the documentation-mutable branch from 4d1f1c4 to 8f91615CompareAugust 14, 2021 17:47
@lehins
lehins merged commit 83759a8 into haskell:masterAug 15, 2021
@lehins

Copy link
Copy Markdown
Contributor

@konsumlamm Thank you!

@konsumlamm
konsumlamm deleted the documentation-mutable branch August 15, 2021 12:19
Sign up for freeto 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.

2 participants

@konsumlamm@lehins