purescript-contrib / purescript-formatters

Formatting and printing for numeric and date/time/interval values
Apache License 2.0
41 stars 30 forks source link

Library doesn't have sufficient module documentation #60

Open thomashoneyman opened 4 years ago

thomashoneyman 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.

Most of the publicly-exported functions and types in this library have no documentation whatsoever.

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.