Re:Arduino-copilot makes it easy to use Haskell to program a...
by sjakobi on Sunday January 26, 2020 @05:42AM
(#22151448)
Hm, I'm afraid to say that I can't find a good resource on how to write and build docs for Haskell libraries. Maybe that's a tutorial you could write once you've figured it out?! ;)
Here are a few links though:
* https://ndmitchell.com/downloads/slides-drive-by_haskell_con...
* https://haskell-haddock.readthedocs.io/en/latest/markup.html
* https://docs.haskellstack.org/en/stable/build_command/#synon...
Also, maybe join the #haskell-beginners channel on Slack: https://fpchat-invite.herokuapp.com/
There are other platforms too though, e.g. https://www.reddit.com/r/haskellquestions/, https://discourse.haskell.org/
Re:Arduino-copilot makes it easy to use Haskell to program a...
by chowells on Saturday January 25, 2020 @11:55PM
(#22150454)
The Haskell documentation generation tool is named haddock. It comes with GHC. I've never run it standalone, so I don't know how involved that is. But I frequently run it with the command "cabal haddock", which takes care of telling it where all your source files are and where to drop the output.
Re:Arduino-copilot makes it easy to use Haskell to program a...
by ph2082 on Sunday January 26, 2020 @04:24AM
(#22151236)
Thank for reply. I'll dig into it. Kind of documentation I am thinking about not only description of what method do, but also include example of 'how to use' it.
Re:Arduino-copilot makes it easy to use Haskell to program a...
by sjakobi on Sunday January 26, 2020 @05:47AM
(#22151473)
Doctests are often useful to briefly demonstrate how something works: http://hackage.haskell.org/package/doctest
They are a bit finicky to set up though.
Another good resource: http://yannesposito.com/Scratch/en/blog/Haskell-Tutorials--a...
Is there a way other people can contribute to documentation ? Also how to generate documentation like found in Hoogle ?