purescript-contrib / purescript-aff-bus

Many-to-many broadcasting
Apache License 2.0
16 stars 12 forks source link

Library doesn't have sufficient module documentation #23

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.

This library currently doesn't have sufficient module documentation -- several publicly-exported types have no documentation at all.

Describe the solution you'd like These types all need documentation:

https://github.com/purescript-contrib/purescript-aff-bus/blob/3d6d0de61beeddefe9616a0b1b1a1e6d16bd9157/src/Effect/Aff/Bus.purs#L46-L58

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.