You can’t. You’re using >>>. In order to have this rendered as an example, it needs to be at the beginning of the paragraph. What’s considered a beginning of the paragraph? Anything at the start of a Haddock comment, skipping any white space preceding it. Anything following an empty line. In your scenario you have … Read more
According to this ticket on the stack issue tracker, Stack can currently only build documentation for libraries, but not executables. Cabal can be configured to work with the stack databases with this command: cabal configure –package-db=clear –package-db=global –package-db=$(stack path –snapshot-pkg-db) –package-db=$(stack path –local-pkg-db) after which you can run cabal haddock –executables to generate the documentation. … Read more
I used to write a lot of literate programs. What do you write as Haddock comments and what do you write in the literate part? The external API documentation goes into the Haddock comments. Everything else goes into the literate part. “Everything else” might include: Internal invariants of data structures Why you are doing things … Read more
The | at the start of a comment is Haddock syntax that begins a documentation annotation. An example from the Haddock documentation is: — |The ‘square’ function squares an integer. square :: Int -> Int square x = x * x It also goes on to say The “– |” syntax begins a documentation annotation, … Read more