4 ms·

My 2020 goal is to learn Haskell, so beginner here. Is there a way other people can contribute to documentation ? Also how to generate documentation like found

• chowells 7y ago
  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.
  • ph2082 7y ago
    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.
    • sjakobi 7y ago
      Doctests are often useful to briefly demonstrate how something works: http://hackage.haskell.org/package/doctest 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-tutorial/ http://yannesposito.com/Scratch/en/blog/Haskell-Tutorials--a...
• sjakobi 7y ago
  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_contributions-09_jun_2017.pdf https://ndmitchell.com/downloads/slides-drive-by_haskell_con... * https://haskell-haddock.readthedocs.io/en/latest/markup.html https://haskell-haddock.readthedocs.io/en/latest/markup.html * https://docs.haskellstack.org/en/stable/build_command/#synonyms https://docs.haskellstack.org/en/stable/build_command/#synon... Also, maybe join the #haskell-beginners channel on Slack: https://fpchat-invite.herokuapp.com/ https://fpchat-invite.herokuapp.com/ There are other platforms too though, e.g. https://www.reddit.com/r/haskellquestions/ https://www.reddit.com/r/haskellquestions/, https://discourse.haskell.org/ https://discourse.haskell.org/