Write up some haddocks for ADTs based on Shane's notes

circuithub / rel8

Hey! Hey! Can u rel8?

https://rel8.readthedocs.io

Other

150 stars 38 forks source link

Closed chrisdone-artificial closed 2 years ago

chrisdone-artificial commented 2 years ago

Drive by documentation PR.

I've written up some haddocks for the main Rel8 module for the ADT/sum types support based on the discussion here.
I've added a file test/HaddockExample.hs to give people a full working example
I've added it to the cabal file to make sure it still compiles over time.

Hopefully this will be useful to others.

ocharles commented 2 years ago

I'm going to move this back into where it was in the TOC before, but other than that this LGTM!

chrisdone-artificial commented 2 years ago

👏 😄