Improve documentation & format

haskell / primitive

This package provides various primitive memory-related operations.

Other

114 stars 58 forks source link

Improve documentation & format #320

Closed konsumlamm closed 3 years ago

konsumlamm commented 3 years ago

Changes:

fix doc comments (add missing periods, fix grammar issues)
add missing doc comments for sizeofArray, sizeofMutableArray, sizeofSmallArray, sizeofSmallMutableArray and MVar
extend doc comments for underdocumented functions
remove Setup.hs (it's not used afaict)
remove unnecessary imports
format (I tried to keep the original style, I mostly did stuff like adding spaces around operators and after commas)

konsumlamm commented 3 years ago

@treeowl @chessai @andrewthad could any of you please take a look?

treeowl commented 3 years ago

I'll look today.

On Sat, Sep 11, 2021, 7:43 AM konsumlamm @.***> wrote:

@treeowl https://github.com/treeowl @chessai https://github.com/chessai @andrewthad https://github.com/andrewthad could any of you please take a look?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/haskell/primitive/pull/320#issuecomment-917392829, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAOOF7MUFWKYJMEW26MRP7DUBM6GRANCNFSM5DOYBGBQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

konsumlamm commented 3 years ago

I'll look today.

@treeowl any update?

treeowl commented 3 years ago

Thanks!