Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 4 commits into from
Jun 7, 2022
Merged

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

merged 4 commits into from
Jun 7, 2022

Conversation

chrisdone-artificial
Copy link
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
Copy link
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
Contributor Author

👏 😄

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

@shane-circuithub shane-circuithub Awaiting requested review from shane-circuithub

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@chrisdone-artificial @ocharles