purescript-contrib / purescript-matryoshka

Generalized folds, unfolds, and traversals for fixed point data structures
Apache License 2.0
59 stars 14 forks source link

Library doesn't have sufficient module documentation #18

Open maxdeviant opened 4 years ago

maxdeviant commented 4 years ago

Is your change request related to a problem? Please describe. As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have mostly complete module documentation, preferably uploaded to Pursuit.

This library currently doesn't have sufficient module documentation -- many publicly-exported types and functions don't have any documentation comments.

Describe the solution you'd like The library needs to have documentation comments on the majority (and preferably all) public types and functions. Once updated, we should tag a release and upload new module documentation to Pursuit so that folks can use it.

Additional context See the Governance repository for more information about requirements in the Contributors organization.