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.

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

Find a way to automatically create API docs from code comments #13

Open
JonathanReeve opened this issue Mar 15, 2018 · 0 comments
Open
Labels
good first issue Good for newcomers haskell help wanted Extra attention is needed wishlist Low-priority issues

Comments

@JonathanReeve
Copy link
Owner

It seems like the usual way of writing documentation is using Haddock. Documentation is automatically generated using code comments.

This isn't necessary, but it would be nice, since that way we'd have everything in one place (without having to update the docs page every time there's an API change).

@JonathanReeve JonathanReeve added haskell wishlist Low-priority issues labels Mar 15, 2018
@JonathanReeve JonathanReeve added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers haskell help wanted Extra attention is needed wishlist Low-priority issues
Projects
None yet
Development

No branches or pull requests

1 participant