Skip to content

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

Merged
ocharles merged 4 commits intocircuithub:masterfrom
chrisdone-artificial:chrisdone-artificial/haddocks-for-adts
Jun 7, 2022
Merged

Write up some haddocks for ADTs based on Shane's notes#177
ocharles merged 4 commits intocircuithub:masterfrom
chrisdone-artificial:chrisdone-artificial/haddocks-for-adts

Conversation

@chrisdone-artificial
Copy link
Copy Markdown
Contributor

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 ocharles requested a review from shane-circuithub May 20, 2022 11:31
@ocharles
Copy link
Copy Markdown
Contributor

ocharles commented Jun 7, 2022

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

@ocharles ocharles enabled auto-merge (squash) June 7, 2022 08:11
@ocharles ocharles merged commit 6183b23 into circuithub:master Jun 7, 2022
@chrisdone-artificial chrisdone-artificial deleted the chrisdone-artificial/haddocks-for-adts branch June 7, 2022 08:32
@chrisdone-artificial
Copy link
Copy Markdown
Contributor Author

👏 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants