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

Add haddock comments #10

Open
snowleopard opened this issue Feb 1, 2016 · 3 comments
Open

Add haddock comments #10

snowleopard opened this issue Feb 1, 2016 · 3 comments
Milestone

Comments

@snowleopard
Copy link
Member

Current implementation of concepts lacks Haddock comments. We need to add them as part of converting concepts into a library package and putting it on Hackage.

Haddock syntax: https://www.haskell.org/haddock/doc/html/ch03s08.html

@mvdan
Copy link
Contributor

mvdan commented Feb 1, 2016

When you publish a Go package with inline comments (docs), you can then link to godoc.org like this:

GoDoc

Makes it really easy to navigate the docs, especially via the badge. Is there a service like this for Haskell? I couldn't find anything on a quick google search.

@snowleopard
Copy link
Member Author

I think there is a Hackage badge, e.g.: https://github.com/ndmitchell/shake.

And docs are shown very nicely on Hackage, e.g.: http://hackage.haskell.org/package/shake-0.15.5/docs/Development-Shake.html

@mvdan
Copy link
Contributor

mvdan commented Feb 1, 2016

Ah, okay then.

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

No branches or pull requests

2 participants