Literate Haskell (.lhs) and Haddock

Posted by finnsson on Stack Overflow See other posts from Stack Overflow or by finnsson
Published on 2010-04-25T08:39:05Z Indexed on 2010/04/25 8:43 UTC
Read the original article Hit count: 244

Filed under:

haskell

|

haddock

|

literate-programming

At the moment I'm only using Haddock but after seeing some really interesting examples (e.g. this gist ) of literate Haskell I'm interested in trying it out in a project.

The questions I got are:

What do you write as Haddock comments and what do you write in the literate part?
How do you scale literate programming to multiple files? Can anyone point me to an example where literate programming is used in a package with multiple modules? What is your experience of using literate programming in larger packages?
Which flavour (markdown, latex, ...) of literate Haskell is preferred?
Why are you programming in literate Haskell or plain vanilla Haskell? Are you programming in both styles and if so why?
Do you prefer block-style (\begin{code}) or Bird-style (>)? Why?

© Stack Overflow or respective owner

Related posts about haskell

Learning Haskell: How to remove an item from a List in Haskell

as seen on Stack Overflow - Search for 'Stack Overflow'
Trying to learn Haskell. I am trying to write a simple function to remove a number from a list without using built-in function (delete...I think). For the sake of simplicity, let's assume that the input parameter is an Integer and the list is an Integer list. Here is the code I have, Please tell me… >>> More
Using Data.Heap in Haskell, or reading Haskell docs for a beginner

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm trying to use Haskells Data.Heap module, but I'm incapable of even using it with integers. The only heap I've been capable of using is "empty", which does not take any arguments. Later on I'll figure out how to instance for my needs, but for now I'd be glad if I was even able to test it with… >>> More
What kind of things are easy in Haskell and hard in Scala, and vice versa?

as seen on Programmers - Search for 'Programmers'
There has been some intermingling of Scala and Haskell communities, and I have noticed now and then people commenting on stuff that's supposed to be easy in Haskell and hard and Scala. Less often (maybe because I read Scala questions, not Haskell ones), I see someone mentioning that something in Scala… >>> More
Haskell's cabal dependency problem with happy

as seen on Programmers - Search for 'Programmers'
I have problems installing ghc-mod on my linux machine. cabal worries about "happy" not being available in versione = 1.17: $ cabal install ghc-mod Resolving dependencies... [1 of 1] Compiling Main ( /tmp/haskell-src-exts-1.14.0-1357/haskell-src-exts-1.14.0/Setup.hs, /tmp/haskell-src-exts-1… >>> More
Understanding Haskell's fibonacci

as seen on Stack Overflow - Search for 'Stack Overflow'
fibs :: [Int] fibs = 0 : 1 : [ a + b | (a, b) <- zip fibs (tail fibs)] This generates the Fibonacci sequence. I understand the behaviour of the guards, of :, zip and tail, but I don't understand <-. What is it doing here? >>> More

Related posts about haddock

Literate Haskell (.lhs) and Haddock

as seen on Stack Overflow - Search for 'Stack Overflow'
At the moment I'm only using Haddock but after seeing some really interesting examples (e.g. this gist ) of literate Haskell I'm interested in trying it out in a project. The questions I got are: What do you write as Haddock comments and what do you write in the literate part? How do you scale… >>> More
Enable --hyperlink-source for "cabal install"

as seen on Stack Overflow - Search for 'Stack Overflow'
The command cabal haddock has very useful --hyperlink-source option. I would like to have the source hyperlinked when building documentation with cabal install. The ticket #517 seems to be just about it: http://hackage.haskell.org/trac/hackage/ticket/517 However, perhaps it is possible to set this… >>> More
Enable --hyperling-source for "cabal install"

as seen on Stack Overflow - Search for 'Stack Overflow'
The command cabal haddock has very useful --hyperlink-source option. I would like to have the source hyperlinked when building documentation with cabal install. The ticket #517 seems to be just about it: http://hackage.haskell.org/trac/hackage/ticket/517 However, perhaps it is possible to set this… >>> More
Drupal htaccess redirect - all files in directory to new directory

as seen on Stack Overflow - Search for 'Stack Overflow'
Hiya, I've moved a site to Drupal, but am now getting a lot of 404 errors due to the search engines taking their time to update the indexes. The 404 paths all look similar to this: recipedata/ccp1300006/633_L.jpg recipedata/ccp1500005/risotto.jpg recipedata/ccp1500006/haddock.jpg So I'd like… >>> More